|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.ControllerCommandImpl
An abstract base implemention for any controller command. At a minimum, a command writer has to implement its own performExecute method and set up the proper response data.
Field Summary | |
protected TypedProperty |
requestProperties
|
protected TypedProperty |
responseProperties
|
protected boolean |
retriable
|
protected TypedProperty |
viewReqProperties
|
Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand |
commandContext |
Fields inherited from interface com.ibm.commerce.command.ControllerCommand |
COPYRIGHT |
Fields inherited from interface com.ibm.commerce.command.ECCommand |
defaultCommandClassName |
Fields inherited from interface com.ibm.commerce.command.ECTargetableCommand |
COPYRIGHT |
Constructor Summary | |
ControllerCommandImpl()
ControllerCommandImpl constructor. |
Method Summary | |
boolean |
fulfills(java.lang.Long member,
java.lang.String relationship)
Determines if a given member fulfills a given relationship with the resource. |
java.lang.Long |
getForUserId()
Gets the user Id for a customer agent command. |
boolean |
getGeneric()
Gets the generic property for this command. |
java.lang.Long |
getOwner()
Returns the owner of this command. |
TypedProperty |
getRequestProperties()
Retrieve the request properties associated with a command. |
TypedProperty |
getResolvedRequestProperties()
Gets the resolved request properties associated with this command. |
TypedProperty |
getResponseProperties()
Gets the response properties after a controller command has been executed successfully. |
boolean |
getRetriable()
Gets the retriable property for this command. |
TypedProperty |
getViewInputProperties()
Gets the input properties that will be passed onto the view command. |
boolean |
isGeneric()
Check to see if this is a generic command. |
boolean |
isRetriable()
Check to see if this command is retriable on transaction rollback exception. |
TypedProperty |
mergeProperties(TypedProperty reqProp)
Merges the properties passedto the request with the default properties. |
void |
setForUserId(java.lang.Long value)
Sets the forUserId for a customer agent command. |
void |
setGeneric(boolean value)
Sets the generic property of this command. |
void |
setOwner(java.lang.Long value)
Sets owner for this command for the purpose of command level access control |
void |
setRequestProperties(TypedProperty reqProperties)
Sets the requestProperties for the command. |
void |
setResponseProperties(TypedProperty respProperties)
Sets the response properties. |
void |
setRetriable(boolean value)
Sets the retriable properties for this command. |
void |
setViewInputProperties(TypedProperty reqProperties)
Sets the input properties to be passed to the for the view command. |
Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand |
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, performExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters |
Methods inherited from interface com.ibm.commerce.command.ControllerCommand |
execute |
Methods inherited from interface com.ibm.commerce.command.AccCommand |
accessControlCheck, getAccCheck, setAccCheck |
Methods inherited from interface com.ibm.commerce.command.ECCommand |
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters |
Field Detail |
protected TypedProperty requestProperties
protected TypedProperty responseProperties
protected boolean retriable
protected TypedProperty viewReqProperties
Constructor Detail |
public ControllerCommandImpl()
Method Detail |
public boolean fulfills(java.lang.Long member, java.lang.String relationship) throws java.rmi.RemoteException, java.lang.Exception
fulfills
in interface Protectable
member
- Member id of the memberrelationship
- The relationship the member has with respect to the resourcepublic java.lang.Long getForUserId()
getForUserId
in interface AccCommand
public boolean getGeneric()
getGeneric
in interface ControllerCommand
public java.lang.Long getOwner() throws java.rmi.RemoteException, java.lang.Exception
getOwner
in interface Protectable
java.rmi.RemoteException.
- Exception.
- public TypedProperty getRequestProperties()
getRequestProperties
in interface ControllerCommand
public TypedProperty getResolvedRequestProperties()
getResolvedRequestProperties
in interface ControllerCommand
public TypedProperty getResponseProperties()
getResponseProperties
in interface ControllerCommand
public boolean getRetriable()
getRetriable
in interface ControllerCommand
public TypedProperty getViewInputProperties()
getViewInputProperties
in interface ControllerCommand
public boolean isGeneric()
isGeneric
in interface ControllerCommand
public boolean isRetriable()
isRetriable
in interface ControllerCommand
public TypedProperty mergeProperties(TypedProperty reqProp)
mergeProperties
in interface ControllerCommand
requestProp
- com.ibm.commerce.datatype.TypedProperty - input request propertiespublic void setForUserId(java.lang.Long value)
setForUserId
in interface AccCommand
value
- Long - userIDpublic final void setGeneric(boolean value)
setGeneric
in interface ControllerCommand
value
- boolean - true if the command is a generic command
false if this command is not a generic commandpublic void setOwner(java.lang.Long value)
setOwner
in interface AccCommand
java.lang.Long
- public void setRequestProperties(TypedProperty reqProperties) throws ECException
setRequestProperties
in interface ControllerCommand
requestProperties
- com.ibm.commerce.datatype.TypedPropertycom.ibm.commerce.exception.ECException.
- public void setResponseProperties(TypedProperty respProperties)
respProperties
- com.ibm.commerce.datatype.TypedPropertypublic final void setRetriable(boolean value)
setRetriable
in interface ControllerCommand
value
- boolean - true if retriable
false if not retriablepublic void setViewInputProperties(TypedProperty reqProperties) throws ECException
setViewInputProperties
in interface ControllerCommand
requestProperties
- com.ibm.commerce.datatype.TypedPropertycom.ibm.commerce.exception.ECException.
-
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |