public abstract class AbstractActionBusinessObjectDocumentCmdImpl extends MeasuredCacheableCommandImpl implements BusinessObjectDocumentCmd
An abstract implementation of a command that represents the any verb that contains actions when dealing with business object documents. This abstract class provides the structure and object hierarchy to follow when creating a command to represent the action based verb. Any command implementation that represents action enabled verb of a business object document should extend from this abstract implementation.
Modifier | Constructor and Description |
---|---|
protected | AbstractActionBusinessObjectDocumentCmdImpl()
Creates an instance of the change business object document command.
|
Modifier and Type | Method and Description |
---|---|
protected CommerceFoundationFactory | getCommerceFoundationFactory()
This method returns an instance of the commerce foundation factory to create Java objects defined in the Commerce foundation.
|
protected java.lang.String | getNounPostActionCommandInterface()
This method returns the interface name of the command that represents the tasks performed after the noun is changed.
|
protected java.lang.String | getNounPreActionCommandInterface()
This method returns the interface name of the command that represents the tasks performed before the noun is changed.
|
protected Oagis9Factory | getOagis9Factory()
This method returns an instance of the factory to create the OAGIS 9 Java objects.
|
protected BusinessObjectDocumentType | getRequestBusinessObjectDocument()
This method returns the request business object document that represents the request.
|
BusinessObjectDocumentType | getResultBusinessObjectDocument()
This method returns the response business object document that represents the result of executing the request.
|
protected java.util.HashMap<java.lang.String,java.lang.String> | getSearchFields(BusinessObjectDocumentType businessObjectDocument)
This method creates the search fields associated for a business audit entry.
|
java.util.Collection | getUniqueID()
This method returns a collection of unique IDs of the nouns involved with this change request.
|
java.lang.String | getUniqueIDXPath()
This method returns the XPath expression from the noun to use to retrieve the unique ID of the noun.
|
void | handleException(java.lang.Exception exception)
This method sets the exception as the result of executing the request.
|
protected boolean | isGenericRequest()
This method returns true if the current request is being made as a generic user.
|
boolean | isReadyToCallExecute()
This method always indicates the command is ready to execute.
|
protected abstract void | performAction()
This method should perform the intended action on the business object document.
|
void | performExecute()
This method will execute the change command by calling validateAction and performAction.
|
void | setRequestBusinessObjectDocument(BusinessObjectDocumentType businessObjectDocument)
This method sets the request business object document of the business logic to execute.
|
protected void | setResultBusinessObjectDocument(BusinessObjectDocumentType businessObjectDocument)
This method sets the response business object document that represents the result of executing the request.
|
void | setUniqueIDXPath(java.lang.String uniqueIDXPath)
This method sets the XPath expression from the noun to use to retrieve the unique ID of the noun.
|
protected abstract void | validateAction()
This method should validate the noun with in the business object document.
|
protected AbstractActionBusinessObjectDocumentCmdImpl()
public BusinessObjectDocumentType getResultBusinessObjectDocument()
protected void setResultBusinessObjectDocument(BusinessObjectDocumentType businessObjectDocument)
public void setRequestBusinessObjectDocument(BusinessObjectDocumentType businessObjectDocument)
protected BusinessObjectDocumentType getRequestBusinessObjectDocument()
protected Oagis9Factory getOagis9Factory()
protected CommerceFoundationFactory getCommerceFoundationFactory()
public boolean isReadyToCallExecute()
public final void performExecute() throws java.lang.Exception
public void handleException(java.lang.Exception exception)
protected abstract void performAction() throws java.lang.Exception
protected abstract void validateAction() throws java.lang.Exception
public java.util.Collection getUniqueID()
This method returns a collection of unique IDs of the nouns involved with this change request. This list of unique IDs is to indicate which nouns have been involved with the request and requires to be invalidated. An example of defining the invalidation configuration is as follows.
<invalidation>catalog <component id="getUniqueID" type="method" multipleIDs="true"> <required>true</required> </component> </invalidation>
public void setUniqueIDXPath(java.lang.String uniqueIDXPath)
public java.lang.String getUniqueIDXPath()
protected java.util.HashMap<java.lang.String,java.lang.String> getSearchFields(BusinessObjectDocumentType businessObjectDocument)
protected java.lang.String getNounPostActionCommandInterface()
protected java.lang.String getNounPreActionCommandInterface()
protected boolean isGenericRequest()