Class Campaign
A Campaign is a set of experiences (or site configurations) which may be
deployed as a single unit for a given time frame. The system currently
supports 3 types of experience that may be assigned to a campaign:
Promotions
Slot Configurations
Sorting Rules
This list may be extended in the future.
A campaign can have a start and end date or be open-ended. It may also have
“qualifiers” which determine which customers the campaign applies to.
The currently supported qualifiers are:
Customer groups (where “Everyone” is a possible customer group)
Source codes
Coupons
A campaign can have list of stores or store groups where it can be applicable to.
Property Summary
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
Method Description getCoupons ()Returns the coupons assigned to the campaign. getCustomerGroups ()Returns the customer groups assigned to the campaign. getDescription ()Returns the internal description of the campaign. getEndDate ()Returns the end date of the campaign. getID ()Returns the unique campaign ID. getPromotions ()Returns promotions defined in this campaign in no particular order. getSourceCodeGroups ()Returns the source codes assigned to the campaign. getStartDate ()Returns the start date of the campaign. getStoreGroups ()Returns store groups assigned to the campaign. getStores ()Returns stores assigned to the campaign. isActive ()Returns ‘true’ if the campaign is currently active, otherwise ‘false’. isApplicableInStore ()Returns true if campaign is applicable to store, otherwise false. isApplicableOnline ()Returns true if campaign is applicable to online site, otherwise false. isEnabled ()Returns true if campaign is enabled, otherwise false.
Methods inherited from class ExtensibleObject
describe , getCustom
Methods inherited from class PersistentObject
getCreationDate , getLastModified , getUUID
Methods inherited from class Object
assign , create , create , defineProperties , defineProperty , entries , freeze , fromEntries , getOwnPropertyDescriptor , getOwnPropertyNames , getOwnPropertySymbols , getPrototypeOf , hasOwnProperty , is , isExtensible , isFrozen , isPrototypeOf , isSealed , keys , preventExtensions , propertyIsEnumerable , seal , setPrototypeOf , toLocaleString , toString , valueOf , values
Property Details
ID
ID: String (read-only)
Returns the unique campaign ID.
active
active: Boolean (read-only)
Returns 'true' if the campaign is currently active, otherwise
'false'.
A campaign is active if it is enabled and scheduled for now .
applicableInStore
applicableInStore: Boolean (read-only)
Returns true if campaign is applicable to store, otherwise false.
applicableOnline
applicableOnline: Boolean (read-only)
Returns true if campaign is applicable to online site, otherwise false.
coupons
coupons: Collection (read-only)
Returns the coupons assigned to the campaign.
customerGroups
customerGroups: Collection (read-only)
Returns the customer groups assigned to the campaign.
description
description: String (read-only)
Returns the internal description of the campaign.
enabled
enabled: Boolean (read-only)
Returns true if campaign is enabled, otherwise false.
endDate
endDate: Date (read-only)
Returns the end date of the campaign. If no end date is defined for the
campaign, null is returned. A campaign w/o end date will run forever.
promotions
promotions: Collection (read-only)
Returns promotions defined in this campaign in no particular order.
sourceCodeGroups
sourceCodeGroups: Collection (read-only)
Returns the source codes assigned to the campaign.
startDate
startDate: Date (read-only)
Returns the start date of the campaign. If no start date is defined for the
campaign, null is returned. A campaign w/o start date is immediately
effective.
storeGroups
storeGroups: Collection (read-only)
Returns store groups assigned to the campaign.
stores
stores: Collection (read-only)
Returns stores assigned to the campaign.
Method Details
getCoupons()
getCoupons(): Collection
Returns the coupons assigned to the campaign.
Returns:
All coupons assigned to the campaign.
getCustomerGroups()
getCustomerGroups(): Collection
Returns the customer groups assigned to the campaign.
Returns:
Customer groups assigned to campaign.
getDescription()
getDescription(): String
Returns the internal description of the campaign.
Returns:
Internal description of campaign.
getEndDate()
getEndDate(): Date
Returns the end date of the campaign. If no end date is defined for the
campaign, null is returned. A campaign w/o end date will run forever.
Returns:
getID()
getID(): String
Returns the unique campaign ID.
Returns:
getPromotions()
getPromotions(): Collection
Returns promotions defined in this campaign in no particular order.
Returns:
All promotions defined in campaign.
getSourceCodeGroups()
getSourceCodeGroups(): Collection
Returns the source codes assigned to the campaign.
Returns:
All source code groups assigned to campaign.
getStartDate()
getStartDate(): Date
Returns the start date of the campaign. If no start date is defined for the
campaign, null is returned. A campaign w/o start date is immediately
effective.
Returns:
getStoreGroups()
getStoreGroups(): Collection
Returns store groups assigned to the campaign.
Returns:
All store groups assigned to the campaign.
getStores()
getStores(): Collection
Returns stores assigned to the campaign.
Returns:
All stores assigned to the campaign.
isActive()
isActive(): Boolean
Returns 'true' if the campaign is currently active, otherwise
'false'.
A campaign is active if it is enabled and scheduled for now .
Returns:
true of campaign is active, otherwise false.
isApplicableInStore()
isApplicableInStore(): Boolean
Returns true if campaign is applicable to store, otherwise false.
Returns:
true if campaign is applicable to store, otherwise false.
isApplicableOnline()
isApplicableOnline(): Boolean
Returns true if campaign is applicable to online site, otherwise false.
Returns:
true if campaign is applicable to online site, otherwise false.
isEnabled()
isEnabled(): Boolean
Returns true if campaign is enabled, otherwise false.
Returns:
true if campaign is enabled, otherwise false.
j