com.ibm.commerce.ubf.commands

Class AddFlowAdminRecordCmdImpl

  • java.lang.Object
    • com.ibm.websphere.command.CacheableCommandImpl
      • com.ibm.commerce.command.MeasuredCacheableCommandImpl
        • com.ibm.commerce.command.AbstractECTargetableCommand
          • com.ibm.commerce.command.ControllerCommandImpl
            • com.ibm.commerce.tools.command.ToolsControllerCommandImpl
              • com.ibm.commerce.ubf.commands.AddFlowAdminRecordCmdImpl
  • All Implemented Interfaces:
    com.ibm.commerce.command.AccCommand, com.ibm.commerce.command.ControllerCommand, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.ECTargetableCommand, com.ibm.commerce.security.Protectable, com.ibm.commerce.tools.command.ToolsControllerCommand, AddFlowAdminRecordCmd, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command

    public class AddFlowAdminRecordCmdImpl
extends com.ibm.commerce.tools.command.ToolsControllerCommandImpl
implements AddFlowAdminRecordCmd
    This command processes flowAdmin flows. Administrators may process multiple flows at one time. This command can only be used by administrators.

    This command uses the following AccessBeans:

    • StoreAccessBean
    • FlowAdminAccessBean
    • UserAccessBean

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getFlowIds()
      Gets the list of flow ID to be acted on.
      com.ibm.commerce.accesscontrol.AccessVector getResources()
      Gets the access vector for this command.
      java.lang.String getViewTask()
      Gets the view task name.
      boolean isReadyToCallExecute()
      Verifies that the this command is ready to be executed.
      void performExecute()
      Allows an administrator to add a list of flows.
      void setFlowIds(java.lang.String newFlowIds)
      Sets the list of flow ids to be acted on.
      void setRequestProperties(com.ibm.commerce.datatype.TypedProperty reqParms)
      Saves the Mandatory and optional command parameter values.
      void setViewTask(java.lang.String newViewTask)
      Sets the view task name.
      void validateParameters()
      Validates parameters.

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from class com.ibm.commerce.tools.command.ToolsControllerCommandImpl

        getViewInputProperties

      • Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl

        checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties

      • Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

        accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

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

        checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, 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, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

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

        fulfills, getOwner

    • Field Detail

      • COPYRIGHT

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

      • flowIds

        public java.lang.String flowIds
        Flow ID.

      • viewTask

        public java.lang.String viewTask
        View task.

    • Constructor Detail

      • AddFlowAdminRecordCmdImpl

        public AddFlowAdminRecordCmdImpl()

    • Method Detail

      • getFlowIds

        public java.lang.String getFlowIds()
        Gets the list of flow ID to be acted on.
        Specified by:
        getFlowIds in interface AddFlowAdminRecordCmd
        Returns:
        String The flow ID to be acted on.

      • getResources

        public com.ibm.commerce.accesscontrol.AccessVector getResources()
                                                         throws com.ibm.commerce.exception.ECException
        Gets the access vector for this command.

        Specified by:
        getResources in interface com.ibm.commerce.command.ECCommand
        Overrides:
        getResources in class com.ibm.commerce.command.AbstractECTargetableCommand
        Returns:
        AccessVector - a vector of resource action pairs
        Throws:
        com.ibm.commerce.exception.ECException

      • getViewTask

        public java.lang.String getViewTask()
        Gets the view task name.
        Specified by:
        getViewTask in interface AddFlowAdminRecordCmd
        Returns:
        java.lang.String

      • isReadyToCallExecute

        public boolean isReadyToCallExecute()
        Verifies that the this command is ready to be executed.
        Overrides:
        isReadyToCallExecute in class com.ibm.commerce.command.AbstractECTargetableCommand
        Returns:
        boolean =true if command is ready, otherwise false.

      • performExecute

        public void performExecute()
                    throws com.ibm.commerce.exception.ECException
        Allows an administrator to add a list of flows.
        Specified by:
        performExecute in interface com.ibm.commerce.command.ECCommand
        Overrides:
        performExecute in class com.ibm.commerce.command.AbstractECTargetableCommand
        Throws:
        com.ibm.commerce.exception.ECSystemException
        com.ibm.commerce.exception.ECException

      • setFlowIds

        public void setFlowIds(java.lang.String newFlowIds)
        Sets the list of flow ids to be acted on.
        Specified by:
        setFlowIds in interface AddFlowAdminRecordCmd
        Parameters:
        newFlowIds - java.jang.String

      • setRequestProperties

        public void setRequestProperties(com.ibm.commerce.datatype.TypedProperty reqParms)
                          throws com.ibm.commerce.exception.ECApplicationException
        Saves the Mandatory and optional command parameter values.
        Specified by:
        setRequestProperties in interface com.ibm.commerce.command.ControllerCommand
        Overrides:
        setRequestProperties in class com.ibm.commerce.tools.command.ToolsControllerCommandImpl
        Parameters:
        requestParam - TypedProperty - Request parameters table.
        Throws:
        ECApplicationException: - An exception is returned if the mandatory parameter (flow id) is missing, or invalid
        com.ibm.commerce.exception.ECApplicationException

      • setViewTask

        public void setViewTask(java.lang.String newViewTask)
        Sets the view task name.
        Specified by:
        setViewTask in interface AddFlowAdminRecordCmd
        Parameters:
        newViewTask - java.jang.String

      • validateParameters

        public void validateParameters()
                        throws com.ibm.commerce.exception.ECException
        Validates parameters.
        Specified by:
        validateParameters in interface com.ibm.commerce.command.ECCommand
        Overrides:
        validateParameters in class com.ibm.commerce.command.AbstractECTargetableCommand
        Throws:
        com.ibm.commerce.exception.ECException
Skip navigation links