Field Detail

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM Copyright notice field.

  See Also:

  Constant Field Values

Constructor Detail

• ProcessAttachmentCmdImpl

  public ProcessAttachmentCmdImpl()
  

  Constructor of ProcessAttachmentCmdImpl

Method Detail

• setProcessAttachment

  public void setProcessAttachment(ProcessAttachmentType processAttachment)
  

  This method sets the ProcessAttachmentType BOD.

  Specified by:

  setProcessAttachment in interface ProcessAttachmentCmd

  Parameters:

  processAttachment - the ProcessAttachment BOD that ProcessAttachmentCmd would execute

• getProcessAttachment

  protected ProcessAttachmentType getProcessAttachment()
  

  This method gets the PrcoessAttachmentType BOD..

  Returns:

  ProcessAttachmentType the ProcessAttachmentType BOD that ProcessAttachmentCmd would execute

• setAcknowledgeAttachment

  protected void setAcknowledgeAttachment(AcknowledgeAttachmentType acknowledgeAttachment)
  

  This method sets the AcknowledgeAttachment BOD.

  Parameters:

  acknowledgeAttachment - the AcknowledgeAttachment BOD would return to the client

• getAcknowledgeAttachment

  public AcknowledgeAttachmentType getAcknowledgeAttachment()
  

  This method gets the AcknowledgeAttachmentType BOD.

  Specified by:

  getAcknowledgeAttachment in interface ProcessAttachmentCmd

  Returns:

  AcknowledgeAttachmentType the AcknowledgeAttachmentType BOD would return to the client

• buildAcknowledgeBusinessObjectDocument

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

  Description copied from class: AbstractProcessBusinessObjectDocumentCmdImpl
  This method builds and returns the business object document that represents the response of this process request.

  Overrides:

  buildAcknowledgeBusinessObjectDocument in class AbstractProcessBusinessObjectDocumentCmdImpl

  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.

  See Also:

  AbstractProcessBusinessObjectDocumentCmdImpl.buildAcknowledgeBusinessObjectDocument(java.util.Map, java.util.Map)

• 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 will be 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 persistent layer to retrieve as much data that will be involved for this request. This data will be passed around to the change part and post business logic commands.

  Overrides:

  read in class AbstractProcessBusinessObjectDocumentCmdImpl

  Parameters:

  nouns - The set of specified nouns to resolve.

  Returns:

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

  Throws:

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

• 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 is the same objects returned by the read() method call. This list contains the changes made by the business logic commands that were executed.

  Overrides:

  save in class AbstractProcessBusinessObjectDocumentCmdImpl

  Parameters:

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

  Throws:

  AbstractApplicationException - There is a problem when persisting the changes.

• validate

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

  This method will perform any common validation the process control will share amongst the differ process action tasks.

  Overrides:

  validate in class AbstractProcessBusinessObjectDocumentCmdImpl

  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.