com.ibm.commerce.catalog.businesscontext

Interface CatalogContext

  • All Superinterfaces:
    Context, java.io.Serializable
    All Known Implementing Classes:
    CatalogContextImpl


    public interface CatalogContext
    extends Context
    The interface will hold information related to the catalog in the current session. The information includes the catalog id, catalog owner and whether this is a master catalog or not.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String CATALOG_ID
      The property name for the catalog Id.
      static java.lang.String CONTEXT_NAME
      This is 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.String MASTER_CATALOG
      The property name for the master catalog flag.
    • 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
        This is the name of the context that will identify it in the CTXDATA table.
        See Also:
        Constant Field Values
      • CATALOG_ID

        static final java.lang.String CATALOG_ID
        The property name for the catalog Id.
        See Also:
        Constant Field Values
      • MASTER_CATALOG

        static final java.lang.String MASTER_CATALOG
        The property name for the master catalog flag.
        See Also:
        Constant Field Values
    • Method Detail

      • getCatalogID

        java.lang.String getCatalogID()
        This method will return the catalog ID of the catalog in context
        Returns:
        Returns the catalog ID.
      • setCatalogID

        void setCatalogID(java.lang.String id)
        This method will set the catalog ID of the catalog in context.
        Parameters:
        id - the catalog ID to set.
      • getOwnerID

        java.lang.String getOwnerID()
        This method will return the catalog owner ID of the catalog in context.
        Returns:
        Returns the owner ID.
      • setOwnerID

        void setOwnerID(java.lang.String id)
        This method will set the catalog owner ID of the catalog in context.
        Parameters:
        id - the owner ID to set.
      • setMasterCatalog

        void setMasterCatalog(boolean isMaster)
        This mehod will set the master catalog flag
        Parameters:
        isMaster - True if this is the master catalog
      • isMasterCatalog

        boolean isMasterCatalog()
        This method will returns whether the catalog in context is a master catalog or not.
        Returns:
        Returns true if this is the master catalog
      • isEntitlementCheckAlwaysEnforced

        boolean isEntitlementCheckAlwaysEnforced()
        This method returns whether the entitlement check is enforced or not.
        Returns:
        Returns true if entitlement check is always enforced