public interface ECCommand
extends com.ibm.websphere.command.Command
All commands will extend from this command interface.
Modifier and Type | Field and Description |
---|---|
static java.lang.String | COPYRIGHT
IBM copyright notice field.
|
static java.lang.String | defaultCommandClassName
This is the default implementation of this command.
|
Modifier and Type | Method and Description |
---|---|
void | checkIsAllowed(java.lang.Object resource, java.lang.String action)
This method determines whether a user can perform a specified action on a specified resource.
|
void | checkResourcePermission()
This method performs resource level access checking.
|
void | createCommandExecutionEvent(com.ibm.commerce.command.event.CommandExecutionTrigger trigger)
This method creates a command execution event.
|
void | execute()
This method is part of the command framework.
|
boolean | getAccCheck()
This method gets the access control flag.
|
CommandContext | getCommandContext()
This method gets the command context associated with this command.
|
java.lang.String | getCommandIfName()
This method gets the interface name of the command.
|
java.lang.String | getCommandName()
This method gets the name of the originating command.
|
java.lang.Integer | getCommandStoreId()
This method gets the store id used to create this command.
|
TypedProperty | getDefaultProperties()
This method gets the default properties associated with this ECCommand object .
|
java.util.Map | getExceptionInvokeParameters(java.lang.String event)
This method returns the attributes for a particular event type when the command executed throws an exception.
|
java.util.Map | getPostInvokeParameters(java.lang.String event)
This method returns the attributes for a particular event type after the command is executed.
|
java.util.Map | getPreInvokeParameters(java.lang.String event)
This method returns the attributes for a particular event type before the command is executed.
|
AccessVector | getResources()
This method gets the access vector accessed by this command.
|
java.lang.Integer | getStoreId()
This method gets the store id associated with this command from the command context.
|
UserAccessBean | getUser()
This method gets a user access bean for the user who invokes this command.
|
java.lang.Long | getUserId()
This method gets the user id of the user who invokes this command from the command context.
|
void | performExecute()
This method contains the actual business logic of this command.
|
void | setAccCheck(boolean newValue)
This method sets the access control flag for this command.
|
void | setCommandContext(CommandContext CommandContext)
This method sets the command context associated with this command.
|
void | setCommandIfName(java.lang.String name)
This method sets the interface name of the command.
|
void | setCommandStoreId(java.lang.Integer storeId)
This method sets the store id used to create this command.
|
void | setDefaultProperties(TypedProperty val)
This method sets the default properties associated with this ECCommand.
|
void | validateParameters()
This method performs server side parameter checking.
|
static final java.lang.String COPYRIGHT
static final java.lang.String defaultCommandClassName
void checkIsAllowed(java.lang.Object resource, java.lang.String action) throws ECException
void execute() throws ECException
boolean getAccCheck()
CommandContext getCommandContext()
java.lang.String getCommandIfName()
java.lang.String getCommandName()
TypedProperty getDefaultProperties()
AccessVector getResources() throws ECException
java.lang.Integer getStoreId()
void setCommandStoreId(java.lang.Integer storeId)
java.lang.Integer getCommandStoreId()
UserAccessBean getUser() throws ECSystemException
java.lang.Long getUserId()
void performExecute() throws com.ibm.websphere.command.CommandException
void setAccCheck(boolean newValue)
void setCommandContext(CommandContext CommandContext)
void setCommandIfName(java.lang.String name)
void setDefaultProperties(TypedProperty val)
void validateParameters() throws ECException
void checkResourcePermission() throws ECException
void createCommandExecutionEvent(com.ibm.commerce.command.event.CommandExecutionTrigger trigger) throws ECException
java.util.Map getPreInvokeParameters(java.lang.String event)
java.util.Map getPostInvokeParameters(java.lang.String event)
java.util.Map getExceptionInvokeParameters(java.lang.String event)