com.ibm.commerce.inventory.facade.client

Class AbstractInventoryFacadeClient

  • Direct Known Subclasses:
    InventoryFacadeClient

    public abstract class AbstractInventoryFacadeClient
extends AbstractBusinessObjectDocumentFacadeClient

    This class provides a set of methods that are used to communicate with the Inventory facade. This class represents a library of performed Inventory operations. The purpose of this class is to hide the details of 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 managed by this client class of the Inventory facade.

    • Constructor Detail

      • AbstractInventoryFacadeClient

        public AbstractInventoryFacadeClient()
        Creates an instance of the client to communicate with the Inventory facade.

      • AbstractInventoryFacadeClient

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

    • Method Detail

      • getInventoryAvailability

        public ShowInventoryAvailabilityType getInventoryAvailability(GetInventoryAvailabilityType aGetInventoryAvailability)
        This method communicates with the Inventory facade and sends the specified GetInventoryAvailability. request.
        Parameters:
        aGetInventoryAvailability - The GetInventoryAvailability request document.
        Returns:
        The resulting ShowInventoryAvailability response document.

      • changeInventoryAvailability

        public RespondInventoryAvailabilityType changeInventoryAvailability(ChangeInventoryAvailabilityType aChangeInventoryAvailability)
        This method communicates with the InventoryAvailability facade and sends the specified ChangeInventoryAvailability request.
        Parameters:
        aChangeInventoryAvailability - The ChangeInventoryAvailability request document.
        Returns:
        The resulting RespondInventoryAvailability response document.

      • syncInventoryAvailability

        public ConfirmBODType syncInventoryAvailability(SyncInventoryAvailabilityType aSyncInventoryAvailability)
        This method communicates with the InventoryAvailability facade and sends the specified SyncInventoryAvailability request.
        Parameters:
        aSyncInventoryAvailability - The SyncInventoryAvailability request document.
        Returns:
        The resulting ConfirmBOD response document.

      • getInventoryAvailability

        public ShowInventoryAvailabilityDataAreaType getInventoryAvailability(GetType getVerb)
                                                               throws InventoryAvailabilityException
        This method returns the ShowInventoryAvailabilityDataArea when issuing the specified get expression to fetch InventoryAvailabilitys. This method is used by other frameworks or methods that construct the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowInventoryAvailabilityDataArea response when issuing the get expression.
        Throws:
        InventoryAvailabilityException - The InventoryAvailabilityException is thrown when error information is found in the specified ShowInventoryAvailabilityDataArea. This indicates that a problem was encountered when performing the operation.

      • getInventoryAvailability

        public java.util.List getInventoryAvailability(java.lang.String expressionLanguage,
                                               java.lang.String expression)
                                        throws InventoryAvailabilityException
        This method returns a list of InventoryAvailabilitys based on the specified expression.
        Parameters:
        expressionLanguage - The expression lanaguage.
        expression - The expression to return a list of InventoryAvailabilitys.
        Returns:
        The list of InventoryAvailabilitys that matches the expression specified.
        Throws:
        InventoryAvailabilityException - The InventoryAvailabilityException is thrown when error information is found in the specified ShowInventoryAvailabilityDataArea. This indicates that a problem was encountered when performing the operation.

      • processInventoryRequirement

        public AcknowledgeInventoryRequirementType processInventoryRequirement(ProcessInventoryRequirementType aProcessInventoryRequirement)
        This method communicates with the Inventory facade and sends the specified ProcessInventoryRequirement request.
        Parameters:
        aProcessInventoryRequirement - The ProcessInventoryRequirement request document.
        Returns:
        The resulting AcknowledgeInventoryRequirement response document.
Skip navigation links