com.ibm.commerce.inventory.facade.client

Class ExternalInventoryFacadeClient

java.lang.Object

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

com.ibm.commerce.inventory.facade.client.ExternalInventoryFacadeClient

public class ExternalInventoryFacadeClient
extends AbstractBusinessObjectDocumentFacadeClient

This class provides common methods that this and other utility classes to the ExternalInventory facade use. This class also provides a set of convenient Java APIs to represent particular ISSExternalWInventory operations.

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

Method Summary

Modifier and Type	Method and Description
ShowInventoryAvailabilityType	getInventoryAvailability(GetInventoryAvailabilityType aGetInventoryAvailability) This method communicates with the ExternalInventory facade and sends the specified GetInventoryAvailability request.
ShowInventoryAvailabilityDataAreaType	getInventoryAvailability(GetType getVerb) This method returns the ShowInventoryAvailabilityDataArea when issuing the specified get expression to fetch InventoryAvailabilitys.
AcknowledgeInventoryRequirementType	processInventoryRequirement(ProcessInventoryRequirementType aProcessInventoryRequirement) This method communicates with the ExternalInventory facade and sends the specified ProcessInventoryRequirement request.

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

ExternalInventoryFacadeClient

public ExternalInventoryFacadeClient()

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

ExternalInventoryFacadeClient

public ExternalInventoryFacadeClient(BusinessContextType businessContext,
                                     javax.security.auth.callback.CallbackHandler callbackHandler)

Creates an instance of the client to communicate with the ExternalInventory 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 ExternalInventory facade and sends the specified GetInventoryAvailability request.

Parameters:

aGetInventoryAvailability - The GetInventoryAvailability request document.

Returns:

The resulting ShowInventoryAvailability response document.

processInventoryRequirement

public AcknowledgeInventoryRequirementType processInventoryRequirement(ProcessInventoryRequirementType aProcessInventoryRequirement)

This method communicates with the ExternalInventory facade and sends the specified ProcessInventoryRequirement request.

Parameters:

aProcessInventoryRequirement - The ProcessInventoryRequirement request document.

Returns:

The resulting AcknowledgeInventoryRequirement 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.