com.ibm.commerce.marketing.facade.datatypes

Interface ActivityType

    • Method Detail

      • getActivityIdentifier

        ActivityIdentifierType getActivityIdentifier()
        Returns the value of the 'Activity Identifier' containment reference. The unique identifier of the activity.
        Returns:
        the value of the 'Activity Identifier' containment reference.
        See Also:
        setActivityIdentifier(ActivityIdentifierType), MarketingPackage.getActivityType_ActivityIdentifier()
      • getCampaignElement

        java.util.List getCampaignElement()
        Returns the value of the 'Campaign Element' containment reference list. The list contents are of type CampaignElementType. The campaign elements associated with the activity.
        Returns:
        the value of the 'Campaign Element' containment reference list.
        See Also:
        MarketingPackage.getActivityType_CampaignElement()
      • getVersion

        java.math.BigInteger getVersion()
        Returns the value of the 'Version' attribute. The current version of the activity.
        Returns:
        the value of the 'Version' attribute.
        See Also:
        setVersion(BigInteger), MarketingPackage.getActivityType_Version()
      • setVersion

        void setVersion(java.math.BigInteger value)
        Sets the value of the 'Version' attribute.
        Parameters:
        value - the new value of the 'Version' attribute.
        See Also:
        getVersion()
      • getPublishedVersion

        java.math.BigInteger getPublishedVersion()
        Returns the value of the 'Published Version' attribute. The published version of the activity.
        Returns:
        the value of the 'Published Version' attribute.
        See Also:
        setPublishedVersion(BigInteger), MarketingPackage.getActivityType_PublishedVersion()
      • setPublishedVersion

        void setPublishedVersion(java.math.BigInteger value)
        Sets the value of the 'Published Version' attribute.
        Parameters:
        value - the new value of the 'Published Version' attribute.
        See Also:
        getPublishedVersion()
      • getState

        java.lang.Object getState()
        Returns the value of the 'State' attribute. The state of the activity.
        Returns:
        the value of the 'State' attribute.
        See Also:
        setState(Object), MarketingPackage.getActivityType_State()
      • setState

        void setState(java.lang.Object value)
        Sets the value of the 'State' attribute.
        Parameters:
        value - the new value of the 'State' attribute.
        See Also:
        getState()
      • getStartDate

        java.lang.Object getStartDate()
        Returns the value of the 'Start Date' attribute. The start date of the activity.
        Returns:
        the value of the 'Start Date' attribute.
        See Also:
        isSetStartDate(), unsetStartDate(), setStartDate(Object), MarketingPackage.getActivityType_StartDate()
      • getEndDate

        java.lang.Object getEndDate()
        Returns the value of the 'End Date' attribute. The end date of the activity.
        Returns:
        the value of the 'End Date' attribute.
        See Also:
        isSetEndDate(), unsetEndDate(), setEndDate(Object), MarketingPackage.getActivityType_EndDate()
      • getPriority

        java.math.BigInteger getPriority()
        Returns the value of the 'Priority' attribute. The priority of the activity.
        Returns:
        the value of the 'Priority' attribute.
        See Also:
        setPriority(BigInteger), MarketingPackage.getActivityType_Priority()
      • setPriority

        void setPriority(java.math.BigInteger value)
        Sets the value of the 'Priority' attribute.
        Parameters:
        value - the new value of the 'Priority' attribute.
        See Also:
        getPriority()
      • getRepeatable

        java.math.BigInteger getRepeatable()
        Returns the value of the 'Repeatable' attribute. The setting if the activity is repeatable.
        Returns:
        the value of the 'Repeatable' attribute.
        See Also:
        setRepeatable(BigInteger), MarketingPackage.getActivityType_Repeatable()
      • setRepeatable

        void setRepeatable(java.math.BigInteger value)
        Sets the value of the 'Repeatable' attribute.
        Parameters:
        value - the new value of the 'Repeatable' attribute.
        See Also:
        getRepeatable()
      • getFormat

        java.lang.Object getFormat()
        Returns the value of the 'Format' attribute. The format type of the activity.
        Returns:
        the value of the 'Format' attribute.
        See Also:
        setFormat(Object), MarketingPackage.getActivityType_Format()
      • setFormat

        void setFormat(java.lang.Object value)
        Sets the value of the 'Format' attribute.
        Parameters:
        value - the new value of the 'Format' attribute.
        See Also:
        getFormat()
      • getTemplateFormat

        java.lang.Object getTemplateFormat()
        Returns the value of the 'Template Format' attribute. The type of activity template.
        Returns:
        the value of the 'Template Format' attribute.
        See Also:
        setTemplateFormat(Object), MarketingPackage.getActivityType_TemplateFormat()
      • setTemplateFormat

        void setTemplateFormat(java.lang.Object value)
        Sets the value of the 'Template Format' attribute.
        Parameters:
        value - the new value of the 'Template Format' attribute.
        See Also:
        getTemplateFormat()
      • getExperimentFormat

        java.lang.Object getExperimentFormat()
        Returns the value of the 'Experiment Format' attribute. The type of experimental activity.
        Returns:
        the value of the 'Experiment Format' attribute.
        See Also:
        setExperimentFormat(Object), MarketingPackage.getActivityType_ExperimentFormat()
      • setExperimentFormat

        void setExperimentFormat(java.lang.Object value)
        Sets the value of the 'Experiment Format' attribute.
        Parameters:
        value - the new value of the 'Experiment Format' attribute.
        See Also:
        getExperimentFormat()
      • getCreated

        java.lang.Object getCreated()
        Returns the value of the 'Created' attribute. The time when the activity was created.
        Returns:
        the value of the 'Created' attribute.
        See Also:
        setCreated(Object), MarketingPackage.getActivityType_Created()
      • setCreated

        void setCreated(java.lang.Object value)
        Sets the value of the 'Created' attribute.
        Parameters:
        value - the new value of the 'Created' attribute.
        See Also:
        getCreated()
      • getLastUpdate

        java.lang.Object getLastUpdate()
        Returns the value of the 'Last Update' attribute. The time when the activity was last updated.
        Returns:
        the value of the 'Last Update' attribute.
        See Also:
        setLastUpdate(Object), MarketingPackage.getActivityType_LastUpdate()
      • setLastUpdate

        void setLastUpdate(java.lang.Object value)
        Sets the value of the 'Last Update' attribute.
        Parameters:
        value - the new value of the 'Last Update' attribute.
        See Also:
        getLastUpdate()
      • getLastUpdatedBy

        java.lang.String getLastUpdatedBy()
        Returns the value of the 'Last Updated By' attribute. The identifier of the user who last updated the activity.
        Returns:
        the value of the 'Last Updated By' attribute.
        See Also:
        setLastUpdatedBy(String), MarketingPackage.getActivityType_LastUpdatedBy()
      • setLastUpdatedBy

        void setLastUpdatedBy(java.lang.String value)
        Sets the value of the 'Last Updated By' attribute.
        Parameters:
        value - the new value of the 'Last Updated By' attribute.
        See Also:
        getLastUpdatedBy()
      • getDescription

        java.lang.String getDescription()
        Returns the value of the 'Description' attribute. The description of the activity.
        Returns:
        the value of the 'Description' attribute.
        See Also:
        setDescription(String), MarketingPackage.getActivityType_Description()
      • setDescription

        void setDescription(java.lang.String value)
        Sets the value of the 'Description' attribute.
        Parameters:
        value - the new value of the 'Description' attribute.
        See Also:
        getDescription()
      • getCampaignIdentifier

        CampaignIdentifierType getCampaignIdentifier()
        Returns the value of the 'Campaign Identifier' containment reference. The unique identifier of the campaign to which the activity belongs.
        Returns:
        the value of the 'Campaign Identifier' containment reference.
        See Also:
        setCampaignIdentifier(CampaignIdentifierType), MarketingPackage.getActivityType_CampaignIdentifier()
      • getRuntimeXMLDefinition

        java.lang.String getRuntimeXMLDefinition()
        Returns the value of the 'Runtime XML Definition' attribute. The marketing runtime representation of the activity.
        Returns:
        the value of the 'Runtime XML Definition' attribute.
        See Also:
        setRuntimeXMLDefinition(String), MarketingPackage.getActivityType_RuntimeXMLDefinition()
      • setRuntimeXMLDefinition

        void setRuntimeXMLDefinition(java.lang.String value)
        Sets the value of the 'Runtime XML Definition' attribute.
        Parameters:
        value - the new value of the 'Runtime XML Definition' attribute.
        See Also:
        getRuntimeXMLDefinition()
      • getMarketingSpotStatistics

        java.util.List getMarketingSpotStatistics()
        Returns the value of the 'Marketing Spot Statistics' containment reference list. The list contents are of type MarketingSpotStatisticsType. The statistics of the emarketing spots associated with this activity.
        Returns:
        the value of the 'Marketing Spot Statistics' containment reference list.
        See Also:
        MarketingPackage.getActivityType_MarketingSpotStatistics()
      • getActivitySequence

        java.lang.String getActivitySequence()
        Returns the value of the 'Activity Sequence' attribute. The number of this version of the activity.
        Returns:
        the value of the 'Activity Sequence' attribute.
        See Also:
        setActivitySequence(String), MarketingPackage.getActivityType_ActivitySequence()
      • setActivitySequence

        void setActivitySequence(java.lang.String value)
        Sets the value of the 'Activity Sequence' attribute.
        Parameters:
        value - the new value of the 'Activity Sequence' attribute.
        See Also:
        getActivitySequence()
      • getFamilyIdentifier

        ActivityIdentifierType getFamilyIdentifier()
        Returns the value of the 'Family Identifier' containment reference. The identifier that indicates that the activity is one of a set of versions of an activity. All versions of an activity will have the same family identifier.
        Returns:
        the value of the 'Family Identifier' containment reference.
        See Also:
        setFamilyIdentifier(ActivityIdentifierType), MarketingPackage.getActivityType_FamilyIdentifier()
      • getMarketingSpotBehavior

        java.lang.String getMarketingSpotBehavior()
        Returns the value of the 'Marketing Spot Behavior' attribute. If this web activity displays the same results to all customers, then the value is 0. If this web activity has dynamic behavior that can display different results, then the value is 1. The associated e-Marketing Spot can use this setting to determine how to cache the e-Marketing Spot results.
        Returns:
        the value of the 'Marketing Spot Behavior' attribute.
        See Also:
        setMarketingSpotBehavior(String), MarketingPackage.getActivityType_MarketingSpotBehavior()
      • setMarketingSpotBehavior

        void setMarketingSpotBehavior(java.lang.String value)
        Sets the value of the 'Marketing Spot Behavior' attribute.
        Parameters:
        value - the new value of the 'Marketing Spot Behavior' attribute.
        See Also:
        getMarketingSpotBehavior()
      • getUIDisplayable

        java.math.BigInteger getUIDisplayable()
        Returns the value of the 'UI Displayable' attribute. This value identifies if this activity should be displayed in the administration UI.
        Returns:
        the value of the 'UI Displayable' attribute.
        See Also:
        setUIDisplayable(BigInteger), MarketingPackage.getActivityType_UIDisplayable()
      • setUIDisplayable

        void setUIDisplayable(java.math.BigInteger value)
        Sets the value of the 'UI Displayable' attribute.
        Parameters:
        value - the new value of the 'UI Displayable' attribute.
        See Also:
        getUIDisplayable()
      • getManagingTool

        java.math.BigInteger getManagingTool()
        Returns the value of the 'Managing Tool' attribute. This value identifies the tool that manages this activity.
        Returns:
        the value of the 'Managing Tool' attribute.
        See Also:
        setManagingTool(BigInteger), MarketingPackage.getActivityType_ManagingTool()
      • setManagingTool

        void setManagingTool(java.math.BigInteger value)
        Sets the value of the 'Managing Tool' attribute.
        Parameters:
        value - the new value of the 'Managing Tool' attribute.
        See Also:
        getManagingTool()
      • getUserData

        UserDataType getUserData()
        Returns the value of the 'User Data' containment reference. User Data.
        Returns:
        the value of the 'User Data' containment reference.
        See Also:
        setUserData(UserDataType), MarketingPackage.getActivityType_UserData()
      • setUserData

        void setUserData(UserDataType value)
        Sets the value of the 'User Data' containment reference.
        Parameters:
        value - the new value of the 'User Data' containment reference.
        See Also:
        getUserData()