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

• getContractFactory

  protected com.ibm.commerce.contract.facade.datatypes.ContractFactory getContractFactory()
  

  This method will return the default instance of the Contract Factory. This factory can be used to create objects defined by the Contract.

  Returns:

  The default Contract Factory.

• 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.

• checkShowContract

  protected ShowContractDataAreaType checkShowContract(ShowContractDataAreaType showContractDataArea)
                                                throws ContractException
  

  This method will examine the ShowContractDataArea to see if there is any error information reported. If there is, then the ContractException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single Contract.

  Parameters:

  showContractDataArea - The show Contract data area to inspect.

  Returns:

  The specified ShowContractDataArea if no error information is found.

  Throws:

  ContractException - The ContractException is thrown if error information is found in the specified ShowContractDataArea. This will represent that there was a problem when performing the operation.

• 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.

• checkShowBusinessAccount

  protected ShowBusinessAccountDataAreaType checkShowBusinessAccount(ShowBusinessAccountDataAreaType showBusinessAccountDataArea)
                                                              throws com.ibm.commerce.contract.facade.client.BusinessAccountException
  

  This method will examine the ShowBusinessAccountDataArea to see if there is any error information reported. If there is, then the BusinessAccountException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single BusinessAccount.

  Parameters:

  showBusinessAccountDataArea - The show BusinessAccount data area to inspect.

  Returns:

  The specified ShowBusinessAccountDataArea if no error information is found.

  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 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.