public class Activity
extends java.lang.Object
implements java.io.Serializable, com.ibm.websphere.cache.Sizeable
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASSNAME
The name of this class.
|
static java.lang.String |
COPYRIGHT
IBM copyright notice field.
|
Constructor and Description |
---|
Activity()
This method is the default constructor.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getActivityFormat()
This method gets the format of the activity.
|
com.ibm.commerce.marketing.internal.runtime.objects.ActivityRootElement |
getActivityRootElement()
This method gets the cached object associated with the runtime XML.
|
java.lang.Short |
getActivityType()
This method gets the type of the activity.
|
java.lang.Integer |
getCampaignId()
This method gets the campaign ID associated with the activity.
|
java.lang.String |
getCampaignName()
This method gets the name of the campaign associated with the activity.
|
java.sql.Timestamp |
getCreatedDate()
This method gets the creation time of the activity.
|
java.lang.Integer |
getCurrentVersion()
This method gets the current version of the activity.
|
java.lang.String |
getDescription()
This method gets the description of the activity.
|
java.sql.Timestamp |
getEndDate()
This method gets the end date of the activity.
|
java.lang.Short |
getExperimentType()
This method gets the type of the experimental activity.
|
java.lang.Integer |
getField1()
This method gets custom field 1 of the activity.
|
java.lang.Long |
getField2()
This method gets custom field 2 of the activity.
|
java.math.BigDecimal |
getField3()
This method gets custom field 3 of the activity.
|
java.lang.String |
getField4()
This method gets custom field 4 of the activity.
|
FlowElement |
getFlowElement(java.lang.String elementId)
This method gets the FlowElement business object associated with the activity.
|
java.lang.String |
getFlowXml()
This method gets the runtime XML associated with the activity.
|
boolean |
getHasOnlyTriggersForAllUsers()
This method gets the setting of whether the activity has only triggers
that are for all users.
|
java.lang.Integer |
getId()
This method gets the unique activity ID.
|
boolean |
getIsActivityRepeatable()
This method gets the setting of whether the activity is repeatable.
|
java.sql.Timestamp |
getLastUpdate()
This method gets the last update time of the activity.
|
java.lang.String |
getLastUpdatedBy()
This method gets the name of the user who last updated the activity.
|
java.lang.Integer |
getMarketingSpotBehavior()
This method gets the caching behavior for the marketing activity
and how it should affect the e-Marketing Spot caching behavior.
|
java.lang.String |
getName()
This method gets the name of the activity.
|
int |
getNumberOfFlowElements()
This method returns the number of flow elements associated with this activity.
|
long |
getObjectSize()
Returns the estimated footprint size in bytes
of this object and the objects it contains.
|
java.lang.Short |
getPriority()
This method gets the priority of the activity.
|
java.lang.Integer |
getPublishedVersion()
This method gets the published version of the activity.
|
java.lang.Short |
getRepeatable()
This method gets the setting if the activity is repeatable.
|
java.sql.Timestamp |
getStartDate()
This method gets the start date of the activity.
|
java.lang.Short |
getState()
This method gets the state of the activity.
|
java.lang.Integer |
getStoreId()
This method gets the store ID associated with the activity.
|
java.lang.Short |
getTemplateType()
This method gets the type of the activity template.
|
void |
putFlowElement(FlowElement element)
This method caches the FlowElement that is associated with the activity.
|
void |
setActivityElementData(com.ibm.commerce.marketing.internal.runtime.objects.ActivityElementData activityElementData)
This method stores the ActivityElementData.
|
void |
setActivityFormat(java.lang.String newActivityFormat)
This method sets the format of the activity.
|
void |
setActivityRootElement(com.ibm.commerce.marketing.internal.runtime.objects.ActivityRootElement newActivityRootElement)
This method sets the cached object associated with the runtime XML.
|
void |
setActivityType(java.lang.Short newActivityType)
This method sets the type of the activity.
|
void |
setCampaignId(java.lang.Integer newCampaignId)
This method sets the campaign ID associated with the activity.
|
void |
setCampaignName(java.lang.String newCampaignName)
This method sets the name campaign associated with the activity.
|
void |
setCreatedDate(java.sql.Timestamp newCreatedDate)
This method sets the creation date of the activity.
|
void |
setCurrentVersion(java.lang.Integer newCurrentVersion)
This method sets the current version of the activity.
|
void |
setDescription(java.lang.String newDescription)
This method sets the description of the activity.
|
void |
setEndDate(java.sql.Timestamp newEndDate)
This method sets the end date of the activity.
|
void |
setExperimentType(java.lang.Short newExperimentType)
This method sets the type of the experimental activity.
|
void |
setField1(java.lang.Integer newField1)
This method sets custom field 1 of the activity.
|
void |
setField2(java.lang.Long newField2)
This method sets custom field 2 of the activity.
|
void |
setField3(java.math.BigDecimal newField3)
This method sets custom field 3 of the activity.
|
void |
setField4(java.lang.String newField4)
This method sets custom field 4 of the activity.
|
void |
setFlowXml(java.lang.String newFlowXml)
This method sets the runtime XML associated with the activity.
|
void |
setHasOnlyTriggersForAllUsers(boolean newHasOnlyTriggersForAllUsers)
This method sets the setting of whether the activity has only triggers
that are for all users.
|
void |
setId(java.lang.Integer newId)
This method sets the unique activity ID.
|
void |
setLastUpdate(java.sql.Timestamp newLastUpdate)
This method sets the last update time of the activity.
|
void |
setLastUpdatedBy(java.lang.String newLastUpdatedBy)
This method sets the name of the user who last updated the activity.
|
void |
setMarketingSpotBehavior(java.lang.Integer newMarketingSpotBehavior)
This method sets the caching behavior for the marketing activity
and how it should affect the e-Marketing Spot caching behavior.
|
void |
setName(java.lang.String newName)
This method sets the name of the activity.
|
void |
setPriority(java.lang.Short newPriority)
This method sets the priority of the activity.
|
void |
setPublishedVersion(java.lang.Integer newPublishedVersion)
This method sets the published version of the activity.
|
void |
setRepeatable(java.lang.Short newRepeatable)
This method sets the setting if the activity is repeatable.
|
void |
setStartDate(java.sql.Timestamp newStartDate)
This method sets the start date of the activity.
|
void |
setState(java.lang.Short newState)
This method sets the state of the activity.
|
void |
setStoreId(java.lang.Integer newStoreId)
This method sets the store ID associated with the activity.
|
void |
setTemplateType(java.lang.Short newTemplateType)
This method sets the type of the activity template.
|
java.lang.String |
toString()
This method returns a string with the content of the marketing activity.
|
public static final java.lang.String COPYRIGHT
public static final java.lang.String CLASSNAME
public Activity()
public long getObjectSize()
getObjectSize
in interface com.ibm.websphere.cache.Sizeable
public java.lang.Integer getId()
public java.lang.String getName()
public java.lang.String getDescription()
public java.lang.Integer getStoreId()
public java.lang.Integer getCampaignId()
public java.lang.String getCampaignName()
public java.lang.Short getState()
public java.sql.Timestamp getLastUpdate()
public java.sql.Timestamp getCreatedDate()
public java.lang.String getLastUpdatedBy()
public java.sql.Timestamp getStartDate()
public java.sql.Timestamp getEndDate()
public java.lang.Short getPriority()
public java.lang.Short getRepeatable()
public boolean getIsActivityRepeatable()
public java.lang.Integer getCurrentVersion()
public java.lang.Integer getPublishedVersion()
public java.lang.Short getActivityType()
public java.lang.String getActivityFormat()
public java.lang.Short getTemplateType()
null
, then this activity is not a template.public java.lang.Short getExperimentType()
null
, then this activity is not an experiment.public java.lang.String getFlowXml()
public java.lang.Integer getField1()
public java.lang.Long getField2()
public java.math.BigDecimal getField3()
public java.lang.String getField4()
public java.lang.Integer getMarketingSpotBehavior()
public void setId(java.lang.Integer newId)
newId
- The unique activity ID.public void setName(java.lang.String newName)
newName
- The name of the activity.public void setDescription(java.lang.String newDescription)
newDescription
- The description of the activity.public void setStoreId(java.lang.Integer newStoreId)
newStoreId
- The store ID associated with the activity.public void setCampaignId(java.lang.Integer newCampaignId)
newCampaignId
- The campaign ID associated with the activity.public void setCampaignName(java.lang.String newCampaignName)
newCampaignName
- The name of the campaign associated with the activity.public void setState(java.lang.Short newState)
newState
- The state of the activity.public void setLastUpdate(java.sql.Timestamp newLastUpdate)
newLastUpdate
- This method sets the last update time of the activity.public void setCreatedDate(java.sql.Timestamp newCreatedDate)
newCreatedDate
- This method sets the creation date of the activity.public void setLastUpdatedBy(java.lang.String newLastUpdatedBy)
newLastUpdatedBy
- The name of the user who last updated the activity.public void setStartDate(java.sql.Timestamp newStartDate)
newStartDate
- This method sets the start date of the activity.public void setEndDate(java.sql.Timestamp newEndDate)
newEndDate
- This method sets the end date of the activity.public void setPriority(java.lang.Short newPriority)
newPriority
- This method sets the priority of the activity.public void setRepeatable(java.lang.Short newRepeatable)
newRepeatable
- This method sets the setting if the activity is repeatable.public void setCurrentVersion(java.lang.Integer newCurrentVersion)
newCurrentVersion
- This method sets the current version of the activity.public void setPublishedVersion(java.lang.Integer newPublishedVersion)
newPublishedVersion
- This method sets the published version of the activity.public void setActivityType(java.lang.Short newActivityType)
newActivityType
- This method sets the type of the activity.public void setActivityFormat(java.lang.String newActivityFormat)
newActivityFormat
- This method sets the format of the activity.public void setTemplateType(java.lang.Short newTemplateType)
null
, then this activity is not a template.newTemplateType
- This method sets the type of the activity template.public void setExperimentType(java.lang.Short newExperimentType)
null
, then this activity is not an experiment.newExperimentType
- This method sets the type of the experimental activity.public void setFlowXml(java.lang.String newFlowXml)
newFlowXml
- The runtime XML associated with the activity.public void setField1(java.lang.Integer newField1)
newField1
- The custom field 1 of the activity.public void setField2(java.lang.Long newField2)
newField2
- The custom field 2 of the activity.public void setField3(java.math.BigDecimal newField3)
newField3
- The custom field 3 of the activity.public void setField4(java.lang.String newField4)
newField4
- The custom field 4 of the activity.public void setMarketingSpotBehavior(java.lang.Integer newMarketingSpotBehavior)
newMarketingSpotBehavior
- Set a value of 1 if the marketing activity
is dynamic, and a value of 0 if it is static.public void setActivityRootElement(com.ibm.commerce.marketing.internal.runtime.objects.ActivityRootElement newActivityRootElement)
newActivityRootElement
- The cached object associated with the runtime XML.public com.ibm.commerce.marketing.internal.runtime.objects.ActivityRootElement getActivityRootElement()
public void setHasOnlyTriggersForAllUsers(boolean newHasOnlyTriggersForAllUsers)
newHasOnlyTriggersForAllUsers
- The setting of whether the activity only
has triggers that are for all users. This is usually true for web activities,
and false for dialog activities.public boolean getHasOnlyTriggersForAllUsers()
public int getNumberOfFlowElements()
public FlowElement getFlowElement(java.lang.String elementId)
elementId
- The ID of the element.public void putFlowElement(FlowElement element)
element
- The FlowElement business object.public void setActivityElementData(com.ibm.commerce.marketing.internal.runtime.objects.ActivityElementData activityElementData)
activityElementData
- The ActivityElementData.public java.lang.String toString()
toString
in class java.lang.Object