Share via


CSFLoadDiscounts

Use this component with the CacheManager object to load discounts for the Content Selection Framework.

Ee798850.note(en-US,CS.10).gif Note

  • Although the CSFLoadDiscounts component implements two pipeline component interfaces (IPipelineComponent and IPipelineComponentAdmin), it is not a pipeline component, it does not appear in the Pipeline Editor, and cannot be used or configured from the Editor.

Configuration Values

None.

Values Read

None.

Values Written

None.

Remarks

You can use the CSFLoadDiscounts component with the CacheManager object to load discounts for use later in your application.

When executed by the CacheManager object, the CSFLoadDiscounts component uses two pipeline dictionaries (Order and Context) to determine how to run and how to return information to the CacheManager object.

The CSFLoadDiscounts component first opens a connection to the database and gets the list of discounts. The component uses a ContentListFactory object to populate a ContentList object with the data. The component then extracts templates, target groups, and page groups from the retrieved information.

Columns in the ContentList

The following table describes the columns in the ContentList object returned by the CSFLoadDiscounts component. Column names appear in alphabetical order.

Column Name Type Flags
award_expr int (CLCOL_I4) 1 (CLCOL_READONLY)
award_max int (CLCOL_I4) 1 (CLCOL_READONLY)
campaign_id int (CLCOL_I4) 1 (CLCOL_READONLY)
click_required Boolean (CLCOL_BOOL) 1 (CLCOL_READONLY)
condition_basis int (CLCOL_I4) 1 (CLCOL_READONLY)
condition_expr int (CLCOL_I4) 1 (CLCOL_READONLY)
condition_mny_min Currency (CLCOL_CY) 1 (CLCOL_READONLY)
condition_qty_min int (CLCOL_I4) 1 (CLCOL_READONLY)
date_end date/time (CLCOL_DATE) 1 (CLCOL_READONLY)
date_modified date/time (CLCOL_DATE) 1 (CLCOL_READONLY)
date_start date/time (CLCOL_DATE) 1 (CLCOL_READONLY)
description String (CLCOL_STRING) 1 (CLCOL_READONLY)
disc_id int (CLCOL_I4) 1 (CLCOL_READONLY)
disjoint Boolean (CLCOL_BOOL) 1 (CLCOL_READONLY)
exposure_limit int (CLCOL_I4) 1 (CLCOL_READONLY)
expressions_used_for_display Boolean (CLCOL_BOOL) 1 (CLCOL_READONLY)
height short (CLCOL_I2) 1 (CLCOL_READONLY)
item_id int (CLCOL_I4) 1 (CLCOL_READONLY)
limit int (CLCOL_I4) 1 (CLCOL_READONLY)
name String (CLCOL_STRING) 1 (CLCOL_READONLY)
offer_type int (CLCOL_I4) 1 (CLCOL_READONLY)
offer_value Currency (CLCOL_CY) 1 (CLCOL_READONLY)
order_level Boolean (CLCOL_BOOL) 1 (CLCOL_READONLY)
pagegroups SafeArray (CLCOL_VARIANTARRAY) 1 (CLCOL_READONLY)
rank int (CLCOL_I4) 1 (CLCOL_READONLY)
required_exprs SafeArray (CLCOL_VARIANTARRAY) 1 (CLCOL_READONLY)
score real (CLCOL_R4) 6 (CLCOL_PRIVATE | CLCOL_SCORE_COLUMN)
size String (CLCOL_STRING) 1 (CLCOL_READONLY)
special_offer_type String (CLCOL_STRING) 1 (CLCOL_READONLY)
target_groups SafeArray (CLCOL_VARIANTARRAY) 1 (CLCOL_READONLY)
template String (CLCOL_STRING) 1 (CLCOL_READONLY)
width short (CLCOL_I2) 1 (CLCOL_READONLY)

Abbreviations in the table above are enumerated values for the ContentList object. For more information, see the Remarks section of ContentListSchema.ColumnType.

Example

See the example in CacheManager Object.


All rights reserved.