ContentList Class (PIA)
Use this object to access a particular collection of content items. The ContentList object provides aggregated access to the private data that it stores, and to the shared data stored in the ContentListFactory object that created it. This object also flows through the Content Selection Framework (CSF) pipeline for the purpose of scoring content items.
Methods
| Method | Description |
|---|---|
| AdjustScore | Adjusts the score associated with an item in the ContentList object by applying a multiplier. |
| BuildIndex | Builds an index on all rows based on the specified column. |
| Filter | Filters items in a ContentList object based on the specified criteria. |
| GetData | Gets data from a specified row and column in a ContentList object in a high-performance, non-scriptable manner. Not useable by Visual Basic .NET or C#. |
| GetScore | Gets the score of an item in a ContentList object. |
| Search | Returns a collection of content items that match the search criteria. |
| SetData | Sets data at a specified row and column in a ContentList object in a high-performance, non-scriptable manner. Not useable by Visual Basic .NET or C#. |
| SetScore | Sets the score of an item in a ContentList object. |
Properties
| Property | Type | Description |
|---|---|---|
| ActiveRows | IRowCollection | The collection of rows that meet the current Threshold and RowLimit properties and that have not been filtered out of the ContentList object.
This property is read-only. |
| AllRows | IRowCollection | The collection of all rows in the ContentList object.
This property is read-only. |
| Count | Integer | Stores the number of rows in the ContentList object.
This property is read/write. |
| Factory | IContentListFactory | Stores a reference to the ContentListFactory object that created this ContentList object.
This property is read-only. |
| Fields | ADODB26Lib.Fields | The Fields collection for a particular row in the ContentList object.
This property is read-only. |
| RowLimit | Integer | Stores the maximum number of rows that can exist in the ActiveRows collection property.
This property is read/write. |
| Sorted | Boolean | Stores a flag that controls whether or not the rows in the ActiveRows collection property are returned sorted by score.
This property is read/write. |
| Threshold | Single | Stores the Threshold score that items must meet to be included in the ActiveRows collection property.
This property is read/write. |
| TraceMessages | ISimpleList | Stores the list of TraceMessage strings accumulated for a particular row in the ContentList object.
This property is read-only. |
| TraceMode | Boolean | Stores the TraceMode value. A value of True enables score tracing, a value of False disables it.
This property is read/write. |
Remarks
Both the ContentList object and the ContentListFactory object implement a common interface, IDataContainer. Therefore, they share the following methods and properties, which are functionally identical on both objects:
Properties:
- AllRows
- Count
- Fields
Methods:
- BuildIndex
- Search
Both objects also expose the GetData and SetData methods. These are not intended for use with C#. Use the get_Fields method instead.
The function of a ContentList object is:
- To aggregate private data in the ContentList object with shared data in the ContentListFactory object.
- To provide functionality for scoring, searching, and filtering the list of content.
The ContentList object is a dependent object. Create a new ContentList object and obtain a IContentList interface by calling the method ContentListFactory.CreateNewContentList.
.gif "Ee823906.important(en-US,CS.20).gif")
Important
- The ContentList and the ContentListFactory objects are designed to be run in-process with their clients.
Requirements
Namespace: Microsoft.CommerceServer.Interop.Caching
Platforms: Windows 2000, Windows Server 2003
Assembly: cachecomplib (in cachecomplib.dll)
Copyright © 2005 Microsoft Corporation.
All rights reserved.