com.ibm.commerce.context.base

Interface BaseContext

  • All Superinterfaces:
    Context, java.io.Serializable


    public interface BaseContext
    extends Context
    The context containing the basic attributes that an activity needs, such as store ID, caller ID, and the run-as ID.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String CHANNEL_ID_CI
      The value in ActivityData objects that identifies a request as coming from the CI channel.
      static java.lang.String CHANNEL_ID_LOBTOOLS
      The value in ActivityData objects that identifies a request as coming from the CMC tools channel.
      static java.lang.String CHANNEL_ID_WEB
      The value in ActivityData objects that identifies a request as coming from the Web channel.
      static java.lang.String CONTEXT_NAME
      The name of the context that will identify it in the CTXDATA table.
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      static java.lang.Integer DEFAULT_STOREID
      The WebSphere Commerce default store ID.
      static java.lang.Long GENERIC_USER_ID
      The WebSphere Commerce generic user ID.
      static java.lang.String KEY_AUTH_USER_ID
      Reserved for IBM internal use.
      static java.lang.String KEY_CHANNEL_ID
      The name of the channelId URL parameter in ActivityData objects.
      static java.lang.String KEY_FOR_USER
      The name of the forUser URL parameter in ActivityData objects.
      static java.lang.String KEY_FOR_USER_ID
      The name of the forUserId URL parameter in ActivityData objects.
      static java.lang.String KEY_STORE_ID
      The name of the storeId URL parameter in ActivityData objects.
      static java.lang.String KEY_USER_ID
      The name of the userId URL parameter in ActivityData objects.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.lang.Long getCallerId()
      This method gets the caller of the session associated with this context.
      java.lang.String getChannelId()
      This method gets the channel that this context's activity is associated with.
      java.lang.Long getRunAsId()
      This method gets the run-as user for the request associated with this context.
      java.lang.Integer getStoreId()
      This method gets the store that this context's activity is associated with.
      void setCallerId(java.lang.Long nCallerId)
      This method sets the caller of the session associated with this context.
      void setChannelId(java.lang.String strChannelId)
      This method sets the channel that this context's activity is associated with.
      void setRunAsId(java.lang.Long nMemberId)
      This method sets the run-as user for the request associated with this context.
      void setStoreId(java.lang.Integer nStoreId)
      This method sets the store that this context's activity is associated with.
    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values
      • CONTEXT_NAME

        static final java.lang.String CONTEXT_NAME
        The name of the context that will identify it in the CTXDATA table.
        See Also:
        Constant Field Values
      • KEY_STORE_ID

        static final java.lang.String KEY_STORE_ID
        The name of the storeId URL parameter in ActivityData objects.
        See Also:
        Constant Field Values
      • KEY_USER_ID

        static final java.lang.String KEY_USER_ID
        The name of the userId URL parameter in ActivityData objects.
        See Also:
        Constant Field Values
      • KEY_AUTH_USER_ID

        static final java.lang.String KEY_AUTH_USER_ID
        Reserved for IBM internal use.
        See Also:
        Constant Field Values
      • KEY_FOR_USER_ID

        static final java.lang.String KEY_FOR_USER_ID
        The name of the forUserId URL parameter in ActivityData objects.
        See Also:
        Constant Field Values
      • KEY_FOR_USER

        static final java.lang.String KEY_FOR_USER
        The name of the forUser URL parameter in ActivityData objects.
        See Also:
        Constant Field Values
      • KEY_CHANNEL_ID

        static final java.lang.String KEY_CHANNEL_ID
        The name of the channelId URL parameter in ActivityData objects.
        See Also:
        Constant Field Values
      • CHANNEL_ID_WEB

        static final java.lang.String CHANNEL_ID_WEB
        The value in ActivityData objects that identifies a request as coming from the Web channel.
        See Also:
        Constant Field Values
      • CHANNEL_ID_CI

        static final java.lang.String CHANNEL_ID_CI
        The value in ActivityData objects that identifies a request as coming from the CI channel.
        See Also:
        Constant Field Values
      • CHANNEL_ID_LOBTOOLS

        static final java.lang.String CHANNEL_ID_LOBTOOLS
        The value in ActivityData objects that identifies a request as coming from the CMC tools channel.
        See Also:
        Constant Field Values
      • DEFAULT_STOREID

        static final java.lang.Integer DEFAULT_STOREID
        The WebSphere Commerce default store ID.
      • GENERIC_USER_ID

        static final java.lang.Long GENERIC_USER_ID
        The WebSphere Commerce generic user ID.
    • Method Detail

      • getCallerId

        java.lang.Long getCallerId()
        This method gets the caller of the session associated with this context.
        Returns:
        the ID of the caller
      • getRunAsId

        java.lang.Long getRunAsId()
        This method gets the run-as user for the request associated with this context.
        Returns:
        the run-as ID
      • getStoreId

        java.lang.Integer getStoreId()
        This method gets the store that this context's activity is associated with.
        Returns:
        the store ID
      • getChannelId

        java.lang.String getChannelId()
        This method gets the channel that this context's activity is associated with.
        Returns:
        the channel ID
      • setCallerId

        void setCallerId(java.lang.Long nCallerId)
        This method sets the caller of the session associated with this context.
        Parameters:
        nCallerId - the caller ID
      • setRunAsId

        void setRunAsId(java.lang.Long nMemberId)
        This method sets the run-as user for the request associated with this context.
        Parameters:
        nMemberId - the run-as ID
      • setStoreId

        void setStoreId(java.lang.Integer nStoreId)
        This method sets the store that this context's activity is associated with.
        Parameters:
        nStoreId - the store ID
      • setChannelId

        void setChannelId(java.lang.String strChannelId)
        This method sets the channel that this context's activity is associated with.
        Parameters:
        strChannelId - the channel ID