com.ibm.commerce.approval.commands

Interface SetApprovalsDetailsViewCmd

  • 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:
    SetApprovalsDetailsViewCmdImpl


    public interface SetApprovalsDetailsViewCmd
    extends com.ibm.commerce.tools.command.ToolsControllerCommand
    Sets the appropriate summary view.

    The command is invoked when a user clicks the "Summary" button while viewing a list of approvals. The selected approval request id is supplied as a parameter to this command. The command will retrieve the entityId corresponding to the approval request. This entity ID will be passed to the view as the ID parameter.

    The view will depend on the flow type associated with the approval request and will be obtained from the VIEWNAME column of the FLOWTYPE table. If the view name is null, it will be set to ApprovalConstants.EC_NO_SUMMARY_VIEW.

    • 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.SetApprovalsDetailsViewCmdImpl"
      static java.lang.String NAME
      The name of this interface is "com.ibm.commerce.approval.commands.SetApprovalsDetailsViewCmd".
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.lang.Long getAprvId()
      Gets the approval request ID.
      void setAprvId(java.lang.Long newAprvId)
      Sets the approval request ID.
      • 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.SetApprovalsDetailsViewCmdImpl"
        See Also:
        Constant Field Values
      • NAME

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

      • getAprvId

        java.lang.Long getAprvId()
        Gets the approval request ID.
        Returns:
        aprvId The approval request ID.
      • setAprvId

        void setAprvId(java.lang.Long newAprvId)
        Sets the approval request ID.
        Parameters:
        newAprvId - The approval request ID.