com.ibm.commerce.contract.facade.client

Class AbstractContractFacadeClient

  • Direct Known Subclasses:
    ContractFacadeClient

    public abstract class AbstractContractFacadeClient
extends AbstractBusinessObjectDocumentFacadeClient

    This class provides a set of methods that can be used to communicate with the Contract facade. This class represents a library of Contract 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 Contract facade.

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM Copyright notice field.
        See Also:
        Constant Field Values

    • Constructor Detail

      • AbstractContractFacadeClient

        public AbstractContractFacadeClient()
        Creates an instance of the client to communicate with the Contract facade.

      • AbstractContractFacadeClient

        public AbstractContractFacadeClient(BusinessContextType businessContext,
                                    javax.security.auth.callback.CallbackHandler callbackHandler)
        Creates an instance of the client to communicate with the Contract 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

      • getContract

        public ShowContractType getContract(GetContractType aGetContract)
        This method will communicate with the Contract facade and send the specified GetContract. request.
        Parameters:
        aGetContract - The GetContract request document.
        Returns:
        The resulting ShowContract response document.

      • getContract

        public ShowContractDataAreaType getContract(GetType getVerb)
                                     throws ContractException
        This method returns the ShowContractDataArea when issuing the specified get expression to fetch Contracts. This method will be used by other frameworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowContractDataArea response when issuing the get expression.
        Throws:
        ContractException - The ContractException is thrown if error information is found in the specified AcknowledgeContractDataArea. This will represent that there was a problem when performing the operation.

      • getContract

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

      • getBusinessAccount

        public ShowBusinessAccountType getBusinessAccount(GetBusinessAccountType aGetBusinessAccount)
        This method will communicate with the Contract facade and send the specified GetBusinessAccount. request.
        Parameters:
        aGetBusinessAccount - The GetBusinessAccount request document.
        Returns:
        The resulting ShowBusinessAccount response document.

      • getBusinessAccount

        public ShowBusinessAccountDataAreaType getBusinessAccount(GetType getVerb)
                                                   throws com.ibm.commerce.contract.facade.client.BusinessAccountException
        This method returns the ShowBusinessAccountDataArea when issuing the specified get expression to fetch BusinessAccounts. This method will be used by other frameworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowBusinessAccountDataArea response when issuing the get expression.
        Throws:
        BusinessAccountException - The BusinessAccountException is thrown if error information is found in the specified ShowBusinessAccountDataArea. This will represent that there was a problem when performing the operation.

      • getBusinessAccount

        public java.util.List getBusinessAccount(java.lang.String expressionLanguage,
                                         java.lang.String expression)
                                  throws com.ibm.commerce.contract.facade.client.BusinessAccountException
        This method returns a list of BusinessAccounts based on the expression specified.
        Parameters:
        expressionLanguage - The expression language.
        expression - The expression to return a list of BusinessAccounts.
        Returns:
        The list of BusinessAccounts that matches the expression specified.
        Throws:
        BusinessAccountException - The BusinessAccountException is thrown if error information is found in the specified ShowBusinessAccountDataArea. This will represent that there was a problem when performing the operation.
Skip navigation links