com.ibm.commerce.accesscontrol.policyeditor.commands
Interface ActGrpAddCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand, Protectable, ToolsControllerCommand
All Known Implementing Classes:
ActGrpAddCmdImpl

public interface ActGrpAddCmd
extends ToolsControllerCommand

Adds a new action Group to the datasource. Following is the list of the parameters the command accepts from the User Interface:

    Mandatory parameters
  1. viewtaskname - View that is executed upon completion of the command
  2. actionId - Comma delimited string of action ids
  3. actGrpName - Name of the new action group
  4. actGrpDisplayName -Display name of the new action group

    Nullable parameters
  1. actGrpDesc - Description of the new action group
This command creates a new entry in the action group table. Using the dynamically generated actionGroupId for this new entry it also enters a description for the action group in the action group description table if a description is specified in the user interface.

The command then parses the comma delimited String containing the actionIds of all the actions to be associated with this action group and iteratively calls the ActionActGrpAddTaskCmd task command to populate the relationship table associating an action group with its constituent actions.


Field Summary
static java.lang.String COPYRIGHT
          copyright notice
static java.lang.String defaultCommandClassName
          name of the default implementation of this command
static java.lang.String NAME
          name of this command
 
Method Summary
 java.lang.String getActGrpDisplayName()
          Gets the display name of the action group.
 java.lang.String getActGrpName()
          Gets the name of the action group.
 java.lang.String getActionIds()
          Gets the list of action ids to be added to the action group.
 java.lang.String getDescription()
          Gets the description of the action group.
 java.lang.String getViewTask()
          Gets the view task name.
 void setActGrpDisplayName(java.lang.String actGrpDisplayName)
          Sets the display name of the action group.
 void setActGrpName(java.lang.String actGrpName)
          Sets the name of the action group.
 void setActionIds(java.lang.String actionIds)
          Sets the list of action ids to be added to the action group.
 void setDescription(java.lang.String description)
          Sets the description of the action group.
 void setViewTask(java.lang.String viewTask)
          Sets the view task name to be returned to the caller.
 
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
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, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
copyright notice

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
name of the default implementation of this command

NAME

public static final java.lang.String NAME
name of this command
Method Detail

getActGrpDisplayName

public java.lang.String getActGrpDisplayName()
Gets the display name of the action group.
Returns:
The display name of the action group

getActGrpName

public java.lang.String getActGrpName()
Gets the name of the action group.
Returns:
The name of the action group

getActionIds

public java.lang.String getActionIds()
Gets the list of action ids to be added to the action group.
Returns:
The comma delimited String of actionIds

getDescription

public java.lang.String getDescription()
Gets the description of the action group.
Returns:
The description of the action group

getViewTask

public java.lang.String getViewTask()
Gets the view task name.
Returns:
View that is executed upon completion of the command

setActGrpDisplayName

public void setActGrpDisplayName(java.lang.String actGrpDisplayName)
Sets the display name of the action group.
Parameters:
actGrpDisplayName - The display name of the action group

setActGrpName

public void setActGrpName(java.lang.String actGrpName)
Sets the name of the action group.
Parameters:
actGrpName - The name of the action group

setActionIds

public void setActionIds(java.lang.String actionIds)
Sets the list of action ids to be added to the action group.
Parameters:
actionIds - The comma delimited String of actionIds

setDescription

public void setDescription(java.lang.String description)
Sets the description of the action group.
Parameters:
description - The description of the action group

setViewTask

public void setViewTask(java.lang.String viewTask)
Sets the view task name to be returned to the caller.
Parameters:
viewTask - View that is executed upon completion of the command