com.ibm.commerce.contract.facade.client

Class ContractFacadeClient

java.lang.Object

com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

com.ibm.commerce.contract.facade.client.AbstractContractFacadeClient

com.ibm.commerce.contract.facade.client.ContractFacadeClient

public class ContractFacadeClient
extends AbstractContractFacadeClient

This class provides common methods that this and other utility class to the Contract facade can use. This class also provides a set of convenient Java API to represent particular Contract operations. This set of Java API also includes APIs for Web based requests to transform the name value pair request into the appropriate request documents.

Field Summary

Fields inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

CHANGE_VERB_ACTION_ADD, CHANGE_VERB_ACTION_CHANGE, CHANGE_VERB_ACTION_CREATE, CHANGE_VERB_ACTION_DELETE, CHANGE_VERB_ACTION_UPDATE

Constructor Summary

Constructors

Constructor and Description
ContractFacadeClient() Creates an instance of the client to communicate with the Contract facade.
ContractFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler) Creates an instance of the client to communicate with the Contract facade.

Method Summary

Modifier and Type	Method and Description
ContractType	getContract(long contractId) This method returns the contract that matches the contract id specified.
java.util.List	getEntitledContracts() This method returns a list of contracts which are entitled for current user.

Methods inherited from class com.ibm.commerce.contract.facade.client.AbstractContractFacadeClient

getBusinessAccount, getBusinessAccount, getBusinessAccount, getContract, getContract, getContract

Methods inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

createActionExpression, createChangeVerb, createGetVerb, createGetVerb, createProcessVerb, createSyncVerb

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContractFacadeClient

public ContractFacadeClient()

Creates an instance of the client to communicate with the Contract facade.

ContractFacadeClient

public ContractFacadeClient(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 ContractType getContract(long contractId)
                         throws ContractException

This method returns the contract that matches the contract id specified. All information associated with the contract will be returned.

Parameters:

contractId - The contract ID of the contract to fetch.

Returns:

The contract that matches the specified contract ID will all the associated information populated.

Throws:

ContractException

getEntitledContracts

public java.util.List getEntitledContracts()
                                    throws ContractException

This method returns a list of contracts which are entitled for current user. specified. All information associated with the contract will be returned.

Returns:

List a list of Contracts which are entitled for current user.

Throws:

ContractException