com.ibm.commerce.context.entitlement

Interface EntitlementContext

  • All Superinterfaces:
    Context, java.io.Serializable

    public interface EntitlementContext
extends Context
    Defines the contract information for a particular user within a particular store.

    • 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 that will identify this context in the CTXDATA table.
        See Also:
        Constant Field Values

      • CONTRACT_SEP

        static final java.lang.String CONTRACT_SEP
        The delimiter used in lists of contract IDs.
        See Also:
        Constant Field Values

      • KEY_CONTRACT_ID

        static final java.lang.String KEY_CONTRACT_ID
        The name of the contractId URL parameter in ActivityData objects.
        See Also:
        Constant Field Values

    • Method Detail

      • getCurrentTradingAgreementIds

        java.lang.String getCurrentTradingAgreementIds()
        Gets the contracts that are currently in use in this context.
        Returns:
        the list of contract IDs
        See Also:
        CONTRACT_SEP

      • getEligibleTradingAgreementIds

        java.lang.String getEligibleTradingAgreementIds()
        Gets the contracts that can be used in this context.
        Returns:
        the list of contract IDs
        See Also:
        CONTRACT_SEP

      • reloadEligibleTradingAgreementIds

        java.lang.String reloadEligibleTradingAgreementIds()
        Reload from the database the contracts that can be used in this context.
        Returns:
        the list of contract IDs
        See Also:
        CONTRACT_SEP

      • getSessionTradingAgreementIds

        java.lang.String getSessionTradingAgreementIds()
        Gets the contracts in this context that are associated with the current session.
        Returns:
        the list of contract IDs
        See Also:
        CONTRACT_SEP

      • setCurrentTradingAgreementIds

        void setCurrentTradingAgreementIds(java.lang.String strIds)
        Sets the contract IDs that are currently in use.
        Parameters:
        strIds - the list of the contract IDs currently in use
        See Also:
        CONTRACT_SEP

      • setSessionTradingAgreementIds

        void setSessionTradingAgreementIds(java.lang.String strIds)
        Sets the contracts in this context that are associated with the current session.
        Parameters:
        strIds - the list of contract IDs
        See Also:
        CONTRACT_SEP

      • invalidateTradingAgreement

        void invalidateTradingAgreement(java.lang.String id)
                         throws BusinessContextException
        Removes a contract from this context.
        Parameters:
        id - the ID of the contract to be removed
        Throws:
        BusinessContextException - if there is problem invalidating the contract ID

      • clearTradingAgreements

        void clearTradingAgreements()
        Clears the trading agreements from the entitlement context.

      • getActiveOrganizationId

        java.lang.Long getActiveOrganizationId()
        Gets the active organization for the current store. The default is the user's parent organization.
        Returns:
        The member ID of the organization.

      • setActiveOrganizationId

        void setActiveOrganizationId(java.lang.Long nOrganizationId)
        Sets the active organization for the current store.
        Parameters:
        nOrganizationId - The member ID of the organization.
Skip navigation links
  • Prev Class
  • Next Class