Constructor Detail

• AbstractProcessBusinessObjectDocumentCmdImpl

  public AbstractProcessBusinessObjectDocumentCmdImpl()
  

  Instantiates an instance of the process controller business object document command.

Method Detail

• getProcessNounActionCommandInterface

  protected java.lang.String getProcessNounActionCommandInterface()
  

  This method returns the interface name of the command that represents the implementation to process the actions. This method either returns the interface name specified in the command configuration or returns a default interface name. The default interface name is the same interface name of the current implementation class with Cmd replaced with ActionCmd. For example the interface of the current implementation is ProcessCatalogEntryCmd then the default change part command interface returned would be ProcessCatalogEntryActionCmd.

  Returns:

  The change part command interface used to look up the implementation for the task that is responsible for executing the operation.

• setProcessNounActionCommandInterface

  public void setProcessNounActionCommandInterface(java.lang.String processNounActionCommandInterface)
  

  This method sets the command interface name that represents the business logic that will perform the process actions.

  Parameters:

  processNounActionCommandInterface - The processNounAciton command interface for the process actions.

• validateAction

  protected void validateAction()
                         throws java.lang.Exception
  

  This method validates the action and all the action expressions associated with the action before executing the tasks. The validate action will extract the action expressions from the request business object document. Then the action expressions are grouped by noun for the parts of the noun that is changed. The read() and validate() on the process action noun task commands are executed to read initial data and perform any common validation steps. After an authorization check is performed to determine to ensure the user has the rights to perform the action on the nouns.

  After each group of noun parts has the corresponding business logic task command instantiated, passing theOnce all the commands have a chance action expression and the noun to work on. Each task will have an opportunity to read() more data and validate() the specified requests. All validation errors are gathered and returned, otherwise the processing will continue.

  Specified by:

  validateAction in class AbstractActionBusinessObjectDocumentCmdImpl

  Throws:

  java.lang.Exception - A problem occurred during validating the actions or the sync part task commands should not be instantiated.

• read

  protected java.util.Map read(java.util.Set nouns)
                        throws AbstractApplicationException
  

  The purpose of this method is to return a list of objects that represent the data that is involved with this change request. The read operation is given a set of associated hints on the amount of data required for the different tasks. The read should use this information to use the persistence layer to retrieve as much data that is involved for this request. This data is passed around to the change part and post business logic commands.

  Parameters:

  nouns - The set of specified nouns to resolve.

  Returns:

  A map of persistent objects that is passed along to the change noun part commands and post business logic commands.

  Throws:

  AbstractApplicationException - A problem occurred while retrieving the data required for this command.

• validate

  protected void validate(java.util.Map nounsAndActions,
              java.util.Map persistentObjects)
                   throws AbstractApplicationException
  

  This method performs any common validation the process control will share amongst the different process action tasks.

  Parameters:

  nounsAndActions - the noun and action for this process request

  persistentObjects - The persistent objects from the read() method.

  Throws:

  AbstractApplicationException - A problem with the nouns and actions specified within the request.

• canPerformAction

  protected void canPerformAction(java.util.Map nounsAndActions,
                      java.util.Map persistentObjects)
                           throws AbstractApplicationException
  

  This method performs an authorization check to validate that the current user can perform the actions on the specified nouns.

  Parameters:

  nounsAndActions - The nouns and the actions to perform on those nouns. The nouns is the key to the map and the value is a list of action expressions to perform.

  persistentObjects - The persistent objects returned by the read() method.

  Throws:

  AbstractApplicationException - An authorization exception occurred and the user cannot perform one, some or all the actions specified.

• performAction

  protected void performAction()
                        throws java.lang.Exception
  

  Performs the request by executing the pre-Process, Process, Post-Process business logic commands instantiated in the validateAction() method. After the commands execute successfully, the save() method is called to persist the data. Then the buildAcknowledgeBusinessObjectDocument() methods is called to create the response business object document that represents this request.

  Specified by:

  performAction in class AbstractActionBusinessObjectDocumentCmdImpl

  Throws:

  java.lang.Exception - A problem occurred while executing the business logic commands.

• buildAcknowledgeBusinessObjectDocument

  protected BusinessObjectDocumentType buildAcknowledgeBusinessObjectDocument(java.util.Map nounsAndActions,
                                                                  java.util.Map persistentObjects)
  

  This method builds and returns the business object document that represents the response of this process request.

  Parameters:

  nounsAndActions - A map containing all the nouns involved with this change request and the action expressions associated with the noun.

  persistentObjects - The persistent objects that were passed around to the commands involved with this request.

  Returns:

  The business object document that represents the response for this request.

• save

  protected void save(java.util.Map persistentObjects)
               throws AbstractApplicationException
  

  The purpose of this method is to save the changes that are contained in the list of persistent objects. The persistent objects are the same objects returned by the read() method call. This list contains the changes made by the business logic commands that were executed.

  Parameters:

  persistentObjects - The persistent objects that contains the changes to persist.

  Throws:

  AbstractApplicationException - There is a problem when persisting the changes.

• getNounName

  public java.lang.String getNounName()
  

  This method returns the name of the noun extracted from the request business object document.

  Returns:

  The name of the noun.

• getVerbName

  protected java.lang.String getVerbName()
  

  This method returns the name of the verb to extract from the request business object document. This method returns the Process.

  Returns:

  Will always return Process to represent the process verb.