|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
com.ibm.commerce.command.AbstractECTargetableCommand
This is the abstract base class for all commerce ECTargetableCommands
Field Summary | |
protected CommandContext |
commandContext
|
Fields inherited from interface com.ibm.commerce.command.ECTargetableCommand |
COPYRIGHT |
Fields inherited from interface com.ibm.commerce.command.ECCommand |
defaultCommandClassName |
Constructor Summary | |
AbstractECTargetableCommand()
|
Method Summary | |
boolean |
accessControlCheck()
Performs command level access control check. |
void |
checkIsAllowed(java.lang.Object resource,
java.lang.String action)
Checks to see if the current user can perform an action on a resource. |
void |
checkResourcePermission()
Performs resource level access control check. |
void |
execute()
This method is part of the command framework for execution of a command. |
void |
finalize()
Final clean up of resources. |
boolean |
getAccCheck()
Check to see if access control check is required for this command. |
CommandContext |
getCommandContext()
Gets the command context associated with this command. |
java.lang.String |
getCommandIfName()
Gets the command interface name. |
java.lang.String |
getCommandName()
Gets the name of the originating command. |
TypedProperty |
getDefaultProperties()
Returns the default properties associated with this command. |
AccessVector |
getResources()
Gets the access vector accessed by this command. |
java.lang.Integer |
getStoreId()
Gets the store Id associated with this command from the command context. |
UserAccessBean |
getUser()
Gets the userAccessBean associated with the user. |
java.lang.Long |
getUserId()
Gets the user Id for the user associated with this command from the command context. |
boolean |
isReadyToCallExecute()
isReadyToCallExecute method is called by the Targettable Command frame work before the execution of the command. |
void |
performExecute()
The business logic for this command. |
void |
reset()
This method should be called after a command has been executed to reset its states variables. |
void |
setAccCheck(boolean newValue)
This method is set by the web controller to indicate whether access control check is required for this command. |
void |
setCommandContext(CommandContext aCommandContext)
Sets the command context associated with this command. |
void |
setCommandIfName(java.lang.String name)
Sets the command interface name |
void |
setDefaultProperties(TypedProperty val)
Sets default properties associated with this ECCommand. |
void |
validateParameters()
This is where parameter checking is done. |
Field Detail |
protected CommandContext commandContext
Constructor Detail |
public AbstractECTargetableCommand()
Method Detail |
public boolean accessControlCheck() throws ECException
ECException
- -ECApplicationException indicating an _ERR_USER_AUTHORITY errorpublic void checkIsAllowed(java.lang.Object resource, java.lang.String action) throws ECException
checkIsAllowed
in interface ECCommand
resource
- Object - the resource to be acted onaction
- String - action to be performed on the resourceECException
- public void checkResourcePermission() throws ECException
checkResourcePermission
in interface ECCommand
ECException
- - _ERR_USER_AUTHORITY if user has no permission to perform
the operation on the resource.public final void execute() throws ECException
execute
in interface ECCommand
ECException
- public void finalize()
public boolean getAccCheck()
getAccCheck
in interface ECCommand
public final CommandContext getCommandContext()
getCommandContext
in interface ECCommand
public final java.lang.String getCommandIfName()
getCommandIfName
in interface ECCommand
String
- - comamnd interface namepublic final java.lang.String getCommandName()
getCommandName
in interface ECCommand
String
- - comamnd namepublic final TypedProperty getDefaultProperties()
getDefaultProperties
in interface ECCommand
public AccessVector getResources() throws ECException
getResources
in interface ECCommand
public java.lang.Integer getStoreId()
getStoreId
in interface ECCommand
public final UserAccessBean getUser() throws ECSystemException
getUser
in interface ECCommand
ECSystemException
- The exception description.public java.lang.Long getUserId()
getUserId
in interface ECCommand
public boolean isReadyToCallExecute()
public void performExecute() throws ECException
performExecute
in interface ECCommand
ECException.
- public void reset()
public void setAccCheck(boolean newValue)
setAccCheck
in interface ECCommand
newValue
- boolean - true if access check is required
- false if access check is not requiredpublic final void setCommandContext(CommandContext aCommandContext)
setCommandContext
in interface ECCommand
commandContext
- CommandContext - the command context object.public final void setCommandIfName(java.lang.String name)
setCommandIfName
in interface ECCommand
name
- String - the command interface name.public final void setDefaultProperties(TypedProperty val)
setDefaultProperties
in interface ECCommand
val
- TypedPropertiespublic void validateParameters() throws ECException
validateParameters
in interface ECCommand
ECException.
-
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |