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

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

public interface ResGrpAddCmd
extends ToolsControllerCommand

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

This command creates a new entry in the resource group table. Using the dynamically generated resGroupId for this new entry it also enters a description for the resource group in the resource group description table if a description is specified in the user interface.

The command then parses the comma delimited String containing the resCgryIds of all the resources to be associated with this resource group and iteratively calls the ResCgryResGrpAddTaskCmd task command to populate the relationship table associating an resource group with its constituent resources.


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 getDescription()
          Gets the description of the resource group.
 java.lang.String getResCgryIds()
          Gets the list of resCgry ids to be added to the resource group.
 java.lang.String getResGrpDisplayName()
          Gets the display name of the resource group.
 java.lang.String getResGrpName()
          Gets the name of the resource group.
 java.lang.String getViewTask()
          Gets the view task name.
 void setDescription(java.lang.String description)
          Sets the description of the resource group
 void setResCgryIds(java.lang.String resCgryIds)
          Sets the list of resCgry ids to be added to the resource group.
 void setResGrpDisplayName(java.lang.String resGrpDisplayName)
          Sets the display name of the resource group
 void setResGrpName(java.lang.String resGrpName)
          Sets the name of the resource 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

getDescription

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

getResCgryIds

public java.lang.String getResCgryIds()
Gets the list of resCgry ids to be added to the resource group.
Returns:
The comma delimited String of resCgryIds

getResGrpDisplayName

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

getResGrpName

public java.lang.String getResGrpName()
Gets the name of the resource group.
Returns:
The name of the resource group

getViewTask

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

setDescription

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

setResCgryIds

public void setResCgryIds(java.lang.String resCgryIds)
Sets the list of resCgry ids to be added to the resource group.
Parameters:
resCgryIds - The comma delimited String of resCgryIds

setResGrpDisplayName

public void setResGrpDisplayName(java.lang.String resGrpDisplayName)
Sets the display name of the resource group
Parameters:
resGrpDisplayName - The display name of the resource group

setResGrpName

public void setResGrpName(java.lang.String resGrpName)
Sets the name of the resource group
Parameters:
resGrpName - The name of the resource 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