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

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

public interface PolicyUpdateCmd
extends ToolsControllerCommand

Modifies a pre-existing policy in the datasource. Following is the list of parameters the command accepts from the User Interface:

This command checks to see whether the user logged in is a Site Admin or a Store Admin and if the policy being updated is a default policy. Depending upon the registration type of the user logged in and the type of the policy one of the following four scenarios is handled:
  1. Site Admin tries to modify default policy - Policy is mofified
  2. Site Admin tries to modify non-default policy - Policy is modified
  3. Store Admin tries to modify default policy - a copy of the policy is
    created as a non-default policy and assigned to the current org
  4. Store Admin tries to modify non-default policy - Policy is modified


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.Integer getActionGroupId()
          Gets the action group id tuple of the policy
 java.lang.Long getOwnerId()
          Gets the owner id of the policy
 java.lang.String getPolicyDesc()
          Gets the description of the policy
 java.lang.String getPolicyDisplayName()
          Gets the display name of the policy
 java.lang.Integer getPolicyId()
          Gets the policyId of the policy
 java.lang.String getPolicyName()
          Gets the name of the policy
 java.lang.Integer getRelationId()
          Gets the relation id tuple of the policy
 java.lang.Integer getResourceGroupId()
          Gets the resource group id tuple of the policy
 java.lang.Long getUserGroupId()
          Gets the user group id tuple of the policy
 java.lang.String getViewTask()
          Gets the view task name to be returned to the caller.
 void setActionGroupId(java.lang.Integer actionGroupId)
          Sets the action group id tuple of the policy
 void setOwnerId(java.lang.Long ownerId)
          Sets the owner id of the policy
 void setPolicyDesc(java.lang.String policyDesc)
          Sets the description of the policy
 void setPolicyDisplayName(java.lang.String policyDisplayName)
          Sets the display name of the policy
 void setPolicyId(java.lang.Integer policyId)
          Sets the policyId of the policy
 void setPolicyName(java.lang.String policyName)
          Sets the name of the policy
 void setRelationId(java.lang.Integer relationId)
          Sets the relation id tuple of the policy
 void setResourceGroupId(java.lang.Integer resourceGroupId)
          Sets the resource group id tuple of the policy
 void setUserGroupId(java.lang.Long userGroupId)
          Sets the user group id tuple of the policy
 void setViewTask(java.lang.String newViewTask)
          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

getActionGroupId

public java.lang.Integer getActionGroupId()
Gets the action group id tuple of the policy
Returns:
The action group id tuple of the policy

getOwnerId

public java.lang.Long getOwnerId()
Gets the owner id of the policy
Returns:
The owner id of the policy

getPolicyDesc

public java.lang.String getPolicyDesc()
Gets the description of the policy
Returns:
The description of the policy

getPolicyDisplayName

public java.lang.String getPolicyDisplayName()
Gets the display name of the policy
Returns:
The display name of the policy

getPolicyId

public java.lang.Integer getPolicyId()
Gets the policyId of the policy
Returns:
The policyId of the policy

getPolicyName

public java.lang.String getPolicyName()
Gets the name of the policy
Returns:
The name of the policy

getRelationId

public java.lang.Integer getRelationId()
Gets the relation id tuple of the policy
Returns:
The relation id tuple of the policy

getResourceGroupId

public java.lang.Integer getResourceGroupId()
Gets the resource group id tuple of the policy
Returns:
The resource group id tuple of the policy

getUserGroupId

public java.lang.Long getUserGroupId()
Gets the user group id tuple of the policy
Returns:
The user group id tuple of the policy

getViewTask

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

setActionGroupId

public void setActionGroupId(java.lang.Integer actionGroupId)
Sets the action group id tuple of the policy
Parameters:
actionGroupId - The action group id tuple of the policy

setOwnerId

public void setOwnerId(java.lang.Long ownerId)
Sets the owner id of the policy
Parameters:
ownerId - The owner id of the policy

setPolicyDesc

public void setPolicyDesc(java.lang.String policyDesc)
Sets the description of the policy
Parameters:
policyDesc - The description of the policy

setPolicyDisplayName

public void setPolicyDisplayName(java.lang.String policyDisplayName)
Sets the display name of the policy
Parameters:
policyDisplayName - The display name of the policy

setPolicyId

public void setPolicyId(java.lang.Integer policyId)
Sets the policyId of the policy
Parameters:
policyId - The policyId of the policy

setPolicyName

public void setPolicyName(java.lang.String policyName)
Sets the name of the policy
Parameters:
policyName - The name of the policy

setRelationId

public void setRelationId(java.lang.Integer relationId)
Sets the relation id tuple of the policy
Parameters:
relationId - The relation id tuple of the policy

setResourceGroupId

public void setResourceGroupId(java.lang.Integer resourceGroupId)
Sets the resource group id tuple of the policy
Parameters:
resourceGroupId - The resource group id tuple of the policy

setUserGroupId

public void setUserGroupId(java.lang.Long userGroupId)
Sets the user group id tuple of the policy
Parameters:
userGroupId - The user group id tuple of the policy

setViewTask

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