com.ibm.commerce.foundation.common.datatypes

Interface BusinessContextType



  • public interface BusinessContextType
    A representation of the model object 'Business Context Type'. Type definition of the business context.

    The following features are supported:

    See Also:
    CommerceFoundationPackage.getBusinessContextType()
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.util.List getContextData()
      Returns the value of the 'Context Data' containment reference list.
      java.lang.String getIntent()
      Returns the value of the 'Intent' attribute.
      void setIntent(java.lang.String value)
      Sets the value of the 'Intent' attribute.
    • Method Detail

      • getContextData

        java.util.List getContextData()
        Returns the value of the 'Context Data' containment reference list. The list contents are of type ContextDataType. The context data.
        Returns:
        the value of the 'Context Data' containment reference list.
        See Also:
        CommerceFoundationPackage.getBusinessContextType_ContextData()
      • getIntent

        java.lang.String getIntent()
        Returns the value of the 'Intent' attribute. The intent of the request. The purpose of the intent is to give a hint to the server on the type of request this will be. The server may need to setup the environment to execute the request depending on the intent of the request. Valid intents include: Store - For requests against a store. Authoring - For requests which are used to author content or preview the authored content. Administration - For requests which are meant for administration purposes.
        Returns:
        the value of the 'Intent' attribute.
        See Also:
        setIntent(String), CommerceFoundationPackage.getBusinessContextType_Intent()
      • setIntent

        void setIntent(java.lang.String value)
        Sets the value of the 'Intent' attribute.
        Parameters:
        value - the new value of the 'Intent' attribute.
        See Also:
        getIntent()