com.ibm.commerce.store.facade.client

Class AbstractStoreFacadeClient

  • Direct Known Subclasses:
    StoreFacadeClient

    public abstract class AbstractStoreFacadeClient
extends AbstractBusinessObjectDocumentFacadeClient

    This class provides a set of methods that can be used to communicate with the Store facade. This class represents a library of Store operations that can be performed. The purpose of this class is to hide the details about constructing the business object document that represents the service request into simple Java methods. The complexity of building the request document and making the request is all managed by this client class of the Store facade.

    • Constructor Detail

      • AbstractStoreFacadeClient

        public AbstractStoreFacadeClient()
        Creates an instance of the client to communicate with the Store facade.

      • AbstractStoreFacadeClient

        public AbstractStoreFacadeClient(BusinessContextType businessContext,
                                 javax.security.auth.callback.CallbackHandler callbackHandler)
        Creates an instance of the client to communicate with the Store facade.
        Parameters:
        businessContext - The default business context to associate with the messages when making requests.
        callbackHandler - Used for authentication purposes so the controller can give the authentication information to the transport when required.

    • Method Detail

      • getGeoNode

        public ShowGeoNodeType getGeoNode(GetGeoNodeType aGetGeoNode)
        This method will communicate with the Store facade and send the specified GetGeoNode. request.
        Parameters:
        aGetGeoNode - The GetGeoNode request document.
        Returns:
        The resulting ShowGeoNode response document.

      • getGeoNode

        public ShowGeoNodeDataAreaType getGeoNode(GetType getVerb)
                                   throws GeoNodeException
        This method returns the ShowGeoNodeDataArea when issuing the specified get expression to fetch GeoNodes. This method will be used by other framworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowGeoNodeDataArea response when issuing the get expression.
        Throws:
        GeoNodeException - The GeoNodeException is thrown if error information is found in the specified ShowGeoNodeDataArea. This will represent that there was a problem when performing the operation.

      • getGeoNode

        public java.util.List getGeoNode(java.lang.String expressionLanguage,
                                 java.lang.String expression)
                          throws GeoNodeException
        This method returns a list of GeoNodes based on the expression specified.
        Parameters:
        expressionLanguage - The expression lanaguage.
        expression - The expression to return a list of GeoNodes.
        Returns:
        The list of GeoNodes that matches the expression specified.
        Throws:
        GeoNodeException - The GeoNodeException is thrown if error information is found in the specified ShowGeoNodeDataArea. This will represent that there was a problem when performing the operation.

      • getPhysicalStore

        public ShowPhysicalStoreType getPhysicalStore(GetPhysicalStoreType aGetPhysicalStore)
        This method will communicate with the Store facade and send the specified GetPhysicalStore. request.
        Parameters:
        aGetPhysicalStore - The GetPhysicalStore request document.
        Returns:
        The resulting ShowPhysicalStore response document.

      • getPhysicalStore

        public ShowPhysicalStoreDataAreaType getPhysicalStore(GetType getVerb)
                                               throws PhysicalStoreException
        This method returns the ShowPhysicalStoreDataArea when issuing the specified get expression to fetch PhysicalStores. This method will be used by other framworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowPhysicalStoreDataArea response when issuing the get expression.
        Throws:
        PhysicalStoreException - The PhysicalStoreException is thrown if error information is found in the specified ShowPhysicalStoreDataArea. This will represent that there was a problem when performing the operation.

      • getPhysicalStore

        public java.util.List getPhysicalStore(java.lang.String expressionLanguage,
                                       java.lang.String expression)
                                throws PhysicalStoreException
        This method returns a list of PhysicalStores based on the expression specified.
        Parameters:
        expressionLanguage - The expression lanaguage.
        expression - The expression to return a list of PhysicalStores.
        Returns:
        The list of PhysicalStores that matches the expression specified.
        Throws:
        PhysicalStoreException - The PhysicalStoreException is thrown if error information is found in the specified ShowPhysicalStoreDataArea. This will represent that there was a problem when performing the operation.
Skip navigation links