com.ibm.commerce.approval.commands

Interface HandleApprovalsCmd

  • All Superinterfaces:
    com.ibm.commerce.command.AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.commerce.command.ControllerCommand, com.ibm.commerce.command.ECCommand, com.ibm.commerce.security.Protectable, com.ibm.commerce.tools.command.ToolsControllerCommand
    All Known Implementing Classes:
    HandleApprovalsCmdImpl

    public interface HandleApprovalsCmd
extends com.ibm.commerce.tools.command.ToolsControllerCommand
    Processes approvals or rejections. The approver may either approve or reject one or more approval requests. The approver may supply an optional comment which will be stored in the approval request's record in the APRVSTATUS table. This comment can be viewed by the request submitter.

    Behaviour This command will raise a business flow event to handle each approval or rejection. The business flow event will handle the updating of the APRVSTATUS table as well as any other activities which have been defined for this transition. The status of the approval requests record in the APRVSTATUS table will be updated to 1 for approved or 2 for rejected.

    The command treats each approval or rejection as a separate transaction. It is possible that if command is invoked to process a batch of approvals or rejections, some may succeed and others may fail.

    The command will set the resultMsg for the view it sets to indicate the success or failure of the processing. The value of resultMsg will be the appropriate key into the ubfapprovalsNLS properties file for the message to be displayed by the JSP.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      static java.lang.String defaultCommandClassName
      The default implementation class is "com.ibm.commerce.approval.commands.HandleApprovalsCmdImpl"
      static java.lang.String NAME
      The name of this interface is "com.ibm.commerce.approval.commands.HandleApprovalsCmd".

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.lang.Integer getAprvAct()
      Gets the action.
      java.lang.String getAprvIds()
      Gets the list of approval status IDs to be acted on.
      java.lang.String getComments()
      Gets the comments.
      java.lang.String getViewTask()
      Gets the view task name.
      void setAprvAct(java.lang.Integer newAprvAct)
      Sets the action.
      void setAprvIds(java.lang.String newAprvIds)
      Sets the list of approval status IDs to be acted on.
      void setComments(java.lang.String newComments)
      Sets the comments.
      void setViewTask(java.lang.String newViewTask)
      Sets the view task name.

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface com.ibm.commerce.command.ControllerCommand

        checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties

      • Methods inherited from interface com.ibm.commerce.command.AccCommand

        accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner

      • Methods inherited from interface com.ibm.commerce.command.ECCommand

        checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

      • Methods inherited from interface com.ibm.commerce.security.Protectable

        fulfills, getOwner

    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values

      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation class is "com.ibm.commerce.approval.commands.HandleApprovalsCmdImpl"
        See Also:
        Constant Field Values

      • NAME

        static final java.lang.String NAME
        The name of this interface is "com.ibm.commerce.approval.commands.HandleApprovalsCmd".
        See Also:
        Constant Field Values

    • Method Detail

      • getAprvAct

        java.lang.Integer getAprvAct()
        Gets the action.
        Returns:
        aprvAct The action. This corresponds to the value of the APPROVAL column in the flow transition (FLTRANSITN) table which will be used to select the appropriate transition.

      • getAprvIds

        java.lang.String getAprvIds()
        Gets the list of approval status IDs to be acted on.
        Returns:
        aprvIds The list of comma delimited approval request IDs to be acted on.

      • getComments

        java.lang.String getComments()
        Gets the comments.
        Returns:
        comments The optional approval/rejection comments supplied by the approver.

      • getViewTask

        java.lang.String getViewTask()
        Gets the view task name.
        Returns:
        viewTask The view to set upon completion of the command.

      • setAprvAct

        void setAprvAct(java.lang.Integer newAprvAct)
        Sets the action.
        Parameters:
        newAprvIds - The action. This corresponds to the value of the APPROVAL column in the flow transition (FLTRANSITN) table which will be used to select the appropriate transition.

      • setAprvIds

        void setAprvIds(java.lang.String newAprvIds)
        Sets the list of approval status IDs to be acted on.
        Parameters:
        newAprvIds - The list of approval status IDs to be acted on.

      • setComments

        void setComments(java.lang.String newComments)
        Sets the comments.
        Parameters:
        newComments - The optional approval/rejection comments supplied by the approver.

      • setViewTask

        void setViewTask(java.lang.String newViewTask)
        Sets the view task name.
        Parameters:
        newViewTask - The view task to be set upon completion of the command.
Skip navigation links