com.ibm.commerce.usermanagement.commands
Interface RoleAddCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand, Protectable
All Known Implementing Classes:
RoleAddCmdImpl

public interface RoleAddCmd
extends ControllerCommand

RoleAdd command creates a role at the site level and assigns it to the Root Organization.

Roles are stored in the ROLE table.

Use this command with SSL (Secure Sockets Layer) to ensure that the information are encrypted. To do so type the command with the HTTPS secure protocol.

The parameter roleName is mandatory.

Behavior

Exception Conditions


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String NAME
           
 
Fields inherited from interface com.ibm.commerce.command.ECCommand
defaultCommandClassName
 
Method Summary
 java.lang.String getRoleDescription()
          Get the description of the role.
 java.lang.String getRoleId()
          Get the roleId of the role added.
 java.lang.String getRoleName()
          Get the name of the role.
 void reset()
          Reset all instance variables of the command to initial state so it can be used again.
 void setRoleDescription(java.lang.String astrRoleDescription)
          Set the description of the role
 void setRoleName(java.lang.String astrRoleName)
          Set the name of the role.
 
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

NAME

public static final java.lang.String NAME
Method Detail

getRoleDescription

public java.lang.String getRoleDescription()
Get the description of the role.
Returns:
The description of the role

getRoleId

public java.lang.String getRoleId()
Get the roleId of the role added. Called after the command is execute to get the roleId of the rold just added.
Returns:
The roleId of the role added

getRoleName

public java.lang.String getRoleName()
Get the name of the role.
Returns:
The name of the role

reset

public void reset()
Reset all instance variables of the command to initial state so it can be used again.

setRoleDescription

public void setRoleDescription(java.lang.String astrRoleDescription)
Set the description of the role
Parameters:
astrRoleDescription - The description of the role

setRoleName

public void setRoleName(java.lang.String astrRoleName)
Set the name of the role.
Parameters:
astrRoleName - The name of the role