com.ibm.commerce.foundation.server.command.bod

Class BusinessObjectDocumentProcessor

java.lang.Object

com.ibm.commerce.foundation.server.command.bod.BusinessObjectDocumentProcessor

public class BusinessObjectDocumentProcessor
extends java.lang.Object

This class is the common entry point to invoke commands that will process business object documents. This class instantiates the appropriate command that represents the logic to process the business object document and executes the command. This processor performs the transaction management, environment setup and other quality of service requirements for processing business object documents. This process understands the high level processing rules when processing successful and unsuccessful business object documents.

Method Summary

Modifier and Type	Method and Description
static void	associateContainer(BusinessObjectDocumentType request, BusinessObjectDocumentType response) This method associates a container with the response business object document.
com.ibm.commerce.foundation.internal.server.command.bod.BusinessObjectDocumentAuditProvider	getBusinessObjectDocumentAuditProvider() This method returns the audit provider used to audit the command.
static BusinessObjectDocumentProcessor	getInstance() Returns an instance of the business object document processor.
BusinessObjectDocumentType	processBusinessObjectDocument(BusinessObjectDocumentType businessObjectDocument, java.lang.String componentId) This method processes the business object document by executing the appropriate instance of a BusinessObjectDocumentCmd.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static BusinessObjectDocumentProcessor getInstance()

Returns an instance of the business object document processor. This instance should be used to start the processing of a business object document.

Returns:

A shared instance of the business object document processor.

processBusinessObjectDocument

public BusinessObjectDocumentType processBusinessObjectDocument(BusinessObjectDocumentType businessObjectDocument,
                                                                java.lang.String componentId)

This method processes the business object document by executing the appropriate instance of a BusinessObjectDocumentCmd. This method uses the interface associated with the specified business object document and establishes the command implementation. It then executes the command and returns the result. Along with the processing, the additional environment setup steps are performed.

Parameters:

businessObjectDocument - The business object document to process.

componentId - The component identifier of the component on behalf the request is being processed for.

Returns:

The result of processing the business object document. This response is the corresponding response business object document.

associateContainer

public static void associateContainer(BusinessObjectDocumentType request,
                                      BusinessObjectDocumentType response)

This method associates a container with the response business object document. The container is determined by the container that is associated with the request business object document.

Parameters:

request - The business object document request that contains the container.

response - The business object document response that requires the container to be set.

getBusinessObjectDocumentAuditProvider

public com.ibm.commerce.foundation.internal.server.command.bod.BusinessObjectDocumentAuditProvider getBusinessObjectDocumentAuditProvider()

This method returns the audit provider used to audit the command.

Returns:

The BusinessObjectDocumentAuditProvier;