AbstractBusinessObjectDocumentFacadeClient

java.lang.Object
- com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

Direct Known Subclasses:

AbstractCatalogFacadeClient, AbstractContentFacadeClient, AbstractContractFacadeClient, AbstractExternalOrderFacadeClient, AbstractGiftCenterFacadeClient, AbstractInfrastructureFacadeClient, AbstractInstallmentFacadeClient, AbstractInventoryFacadeClient, AbstractLocationFacadeClient, AbstractMarketingFacadeClient, AbstractMemberFacadeClient, AbstractOrderFacadeClient, AbstractPageLayoutFacadeClient, com.ibm.commerce.price.facade.client.AbstractPriceFacadeClient, AbstractPromotionFacadeClient, AbstractSearchFacadeClient, AbstractStoreFacadeClient, AbstractSubscriptionFacadeClient, AbstractWalletFacadeClient, DOMExternalOrderFacadeClient, ExternalInventoryFacadeClient
```
public abstract class AbstractBusinessObjectDocumentFacadeClient
extends java.lang.Object
```
Common client facade for business object documents. This client offers static and non-static utility methods to create elements of a business object document. This client facade can also be used as a generic way to send the business object document to the appropriate service module for processing. It is recommended that any client facade for service modules that use business object documents should extend this base client facade.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CHANGE_VERB_ACTION_ADD` The change verb constant to represents the action of Add.
`static java.lang.String`	`CHANGE_VERB_ACTION_CHANGE` The change verb constant to represents the action of Change.
`static java.lang.String`	`CHANGE_VERB_ACTION_CREATE` Deprecated. The preferred action to create is Add.
`static java.lang.String`	`CHANGE_VERB_ACTION_DELETE` The change verb constant to represents the action of Delete.
`static java.lang.String`	`CHANGE_VERB_ACTION_UPDATE` Deprecated. The preferred action to update is Change
`static java.lang.String`	`COPYRIGHT` IBM Copyright notice field.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`AbstractBusinessObjectDocumentFacadeClient()` Creates an instance of the business object document client facade.
	`AbstractBusinessObjectDocumentFacadeClient(BusinessContextType businessContext)` Creates an instance of the business object document client facade.
`protected`	`AbstractBusinessObjectDocumentFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)` Creates an instance of the business object document client facade.
	`AbstractBusinessObjectDocumentFacadeClient(javax.security.auth.callback.CallbackHandler callbackHandler)` Creates an instance of the business object document client facade.

Method Summary

Methods
Modifier and Type	Method and Description
`static ActionExpressionType`	`createActionExpression(java.lang.String actionCode, java.lang.String expressionLanguage, java.lang.String actionExpression)` This method creates an action expression that can be used as part of the `Process`, `Change` or `Sync` verbs.
`static ChangeType`	`createChangeVerb(java.util.List actionExpressions)` This is a utility method to create the Change verb.
`static GetType`	`createGetVerb(ExpressionType selectionCriteriaExpression)` This is a utility method to create the Get verb.
`static GetType`	`createGetVerb(java.lang.String expressionLanguage, java.lang.String expression)` This is a utility method to create the Get verb.
`static ProcessType`	`createProcessVerb(java.util.List actionExpressions)` This is a utility method to create the Process verb.
`static com.ibm.commerce.oagis9.datatypes.SyncType`	`createSyncVerb(java.util.List actionExpressions)` This is a utility method to create the Sync verb.
`protected ApplicationAreaType`	`getApplicationArea()` This method returns the application area associated with the client facade.
`protected BusinessContextType`	`getBusinessContext()` This method returns the specified business context when the client facade was created.
`protected javax.security.auth.callback.CallbackHandler`	`getCallbackHandler()` This method returns the callback handler that is passed to the invocation service for the purpose of authorization for the component request.
`protected CommerceFoundationFactory`	`getCommerceFoundationFactory()` This method returns the default instance of the Commerce Foundation Factory.
`protected Oagis9Factory`	`getOagis9Factory()` This method returns the default instance of the OAGIS 9 Factory.
`protected BusinessObjectDocumentType`	`sendBusinessObjectDocument(java.lang.Class className, java.lang.String serviceName, BusinessObjectDocumentType businessObjectDocument)` This method uses the invocation service to send a generic business object document.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM Copyright notice field.
    
    See Also:
    
    Constant Field Values
  - CHANGE_VERB_ACTION_CREATE
```
public static final java.lang.String CHANGE_VERB_ACTION_CREATE
```
    Deprecated. The preferred action to create is Add.
    
    The change verb constant to represents the action of Create.
    
    See Also:
    
    Constant Field Values
  - CHANGE_VERB_ACTION_UPDATE
```
public static final java.lang.String CHANGE_VERB_ACTION_UPDATE
```
    Deprecated. The preferred action to update is Change
    
    The change verb constant to represents the action of Update.
    
    See Also:
    
    Constant Field Values
  - CHANGE_VERB_ACTION_ADD
```
public static final java.lang.String CHANGE_VERB_ACTION_ADD
```
    The change verb constant to represents the action of Add.
    
    See Also:
    
    Constant Field Values
  - CHANGE_VERB_ACTION_CHANGE
```
public static final java.lang.String CHANGE_VERB_ACTION_CHANGE
```
    The change verb constant to represents the action of Change.
    
    See Also:
    
    Constant Field Values
  - CHANGE_VERB_ACTION_DELETE
```
public static final java.lang.String CHANGE_VERB_ACTION_DELETE
```
    The change verb constant to represents the action of Delete.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractBusinessObjectDocumentFacadeClient
```
public AbstractBusinessObjectDocumentFacadeClient()
```
    Creates an instance of the business object document client facade.
  - AbstractBusinessObjectDocumentFacadeClient
```
public AbstractBusinessObjectDocumentFacadeClient(BusinessContextType businessContext)
```
    Creates an instance of the business object document client facade.
    
    Parameters:
    
    businessContext - The business context to associate with the client request. This will override the default business context that can be found on the thread.
  - AbstractBusinessObjectDocumentFacadeClient
```
public AbstractBusinessObjectDocumentFacadeClient(javax.security.auth.callback.CallbackHandler callbackHandler)
```
    Creates an instance of the business object document client facade.
    
    Parameters:
    
    callbackHandler - The security callback handler that is passed to the invocation service. The responsibility is for resolving the appropriate authentication for the component request. This override the default callback handler that can be found on the thread.
  - AbstractBusinessObjectDocumentFacadeClient
```
protected AbstractBusinessObjectDocumentFacadeClient(BusinessContextType businessContext,
                                          javax.security.auth.callback.CallbackHandler callbackHandler)
```
    Creates an instance of the business object document client facade.
    
    Parameters:
    
    businessContext - The business context to associate with the client request. This will override the default business context that can be found on the thread.
    
    callbackHandler - The security callback handler that is passed to the invocation service. The responsibility is for resolving the appropriate authentication for the component request. This override the default callback handler that can be found on the thread.
- Method Detail
  - createActionExpression
```
public static ActionExpressionType createActionExpression(java.lang.String actionCode,
                                          java.lang.String expressionLanguage,
                                          java.lang.String actionExpression)
```
    This method creates an action expression that can be used as part of the Process, Change or Sync verbs. The action expression returned is based on the specified action code, expression language and action expression.
    
    Parameters:
    
    actionCode - The action code of the action expression. For example, for change verb, "Create", "Update" and "Delete" could be used.
    
    expressionLanguage - The expression language of the action expression.
    
    actionExpression - The action expression.
    
    Returns:
    
    The action expression that can be used in the Process, Change or Sync verb.
  - createProcessVerb
```
public static ProcessType createProcessVerb(java.util.List actionExpressions)
```
    This is a utility method to create the Process verb. This method returns a new instance of the process verb and a single action criteria that contains the action expressions specified.
    
    Parameters:
    
    actionExpressions - A list of ActionExpressionType to associate with the first ActionCriteria of the verb.
    
    Returns:
    
    A new instance of the process verb object. This process verb will contain the action expression specified.
  - createChangeVerb
```
public static ChangeType createChangeVerb(java.util.List actionExpressions)
```
    This is a utility method to create the Change verb. This method returns a new instance of the change verb and a single action criteria that contains the action expressions specified.
    
    Parameters:
    
    actionExpressions - A list of ActionExpressionType to associate with the first ActionCriteria of the verb.
    
    Returns:
    
    A new instance of the change verb object. This change verb will contain the action expression specified.
  - createSyncVerb
```
public static com.ibm.commerce.oagis9.datatypes.SyncType createSyncVerb(java.util.List actionExpressions)
```
    This is a utility method to create the Sync verb. This method returns a new instance of the sync verb and a single action criteria that contains the action expressions specified.
    
    Parameters:
    
    actionExpressions - A list of ActionExpressionType to associate with the first ActionCriteria of the verb.
    
    Returns:
    
    A new instance of the sync verb object. This sync verb will contain the action expression specified.
  - createGetVerb
```
public static GetType createGetVerb(java.lang.String expressionLanguage,
                    java.lang.String expression)
```
    This is a utility method to create the Get verb. This method returns a new instance of the get verb and a single expression type that contains the expression specified.
    
    Parameters:
    
    expressionLanguage - The expression language of the expression.
    
    expression - The search expression for the request.
    
    Returns:
    
    A new instance of the get verb object. This get verb will contain the expression specified.
  - createGetVerb
```
public static GetType createGetVerb(ExpressionType selectionCriteriaExpression)
```
    This is a utility method to create the Get verb. This method returns a new instance of the get verb and a single expression type that contains the expression specified.
    
    Parameters:
    
    selectionCriteriaExpression - A list of ExpressionType for the request
    
    Returns:
    
    A new instance of the get verb object. This get verb will contain the expressions specified.
  - getOagis9Factory
```
protected Oagis9Factory getOagis9Factory()
```
    This method returns the default instance of the OAGIS 9 Factory. This factory can be used to create objects defined by OAGIS.
    
    Returns:
    
    The default OAGIS 9 Factory.
  - getCommerceFoundationFactory
```
protected CommerceFoundationFactory getCommerceFoundationFactory()
```
    This method returns the default instance of the Commerce Foundation Factory. This factory can be used to create objects defined by the Commerce Foundation.
    
    Returns:
    
    The default Commerce Foundation Factory.
  - getApplicationArea
```
protected ApplicationAreaType getApplicationArea()
```
    This method returns the application area associated with the client facade. A new instance of the application area is always returned. The new application area is created with the creation date and time and business context filled and with a unique BOD ID. The business context is resolved by calling the getBusinessContext method.
    
    Returns:
    
    The application area that is associated with this instance of the client facade.
  - getBusinessContext
```
protected BusinessContextType getBusinessContext()
```
    This method returns the specified business context when the client facade was created. If no business context was specified during creation, then the business context found on the thread is used.
    
    Returns:
    
    The business context to associated with the request.
  - getCallbackHandler
```
protected javax.security.auth.callback.CallbackHandler getCallbackHandler()
```
    This method returns the callback handler that is passed to the invocation service for the purpose of authorization for the component request. The callback handler can either be the one specified when the client facade was created or the one associated with the thread.
    
    Returns:
    
    A instance of the callback handler to be used by the invocation service for authorization for the component request.
  - sendBusinessObjectDocument
```
protected BusinessObjectDocumentType sendBusinessObjectDocument(java.lang.Class className,
                                                    java.lang.String serviceName,
                                                    BusinessObjectDocumentType businessObjectDocument)
```
    This method uses the invocation service to send a generic business object document. The method will generically populate the business object document with an application area if one is not specified and call the invocation service to process the object. When calling the invocation service, the callback handler associated with the client instance is passed along. The result of the invocation service request is the responding business object document and that is returned to the caller.
    
    Parameters:
    
    className - The class of the component facade to invoke.
    
    serviceName - The name of the service name.
    
    businessObjectDocument - The business object document for processing.
    
    Returns:
    
    The responding business object document.

Class AbstractBusinessObjectDocumentFacadeClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COPYRIGHT

CHANGE_VERB_ACTION_CREATE

CHANGE_VERB_ACTION_UPDATE

CHANGE_VERB_ACTION_ADD

CHANGE_VERB_ACTION_CHANGE

CHANGE_VERB_ACTION_DELETE

Constructor Detail

AbstractBusinessObjectDocumentFacadeClient

AbstractBusinessObjectDocumentFacadeClient

AbstractBusinessObjectDocumentFacadeClient

AbstractBusinessObjectDocumentFacadeClient

Method Detail

createActionExpression

createProcessVerb

createChangeVerb

createSyncVerb

createGetVerb

createGetVerb

getOagis9Factory

getCommerceFoundationFactory

getApplicationArea

getBusinessContext

getCallbackHandler

sendBusinessObjectDocument