com.ibm.commerce.tickler.commands
Class TicklerActionRecordCmdImpl
- java.lang.Object
-
- com.ibm.websphere.command.TargetableCommandImpl
-
- com.ibm.websphere.command.CacheableCommandImpl
-
- com.ibm.commerce.command.MeasuredCacheableCommandImpl
-
- com.ibm.commerce.command.AbstractECTargetableCommand
-
- com.ibm.commerce.command.ControllerCommandImpl
-
- com.ibm.commerce.tickler.commands.TicklerActionRecordCmdImpl
-
- All Implemented Interfaces:
- AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, Protectable, TicklerActionRecordCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable
public class TicklerActionRecordCmdImpl extends ControllerCommandImpl implements TicklerActionRecordCmd
The classTicklerActionRecordCmdImpl
is used to record a Customer Service Representative action on a tickler, closing the tickler if the action is a resolving action.Mandatory parameters:
ticklerId
,ticklerActionId
,URL
Optional parameters:
actionDate
,inAssignToMemberId
,comment
Behavior:
- Checks if the supplied tickler ID is valid.
- Checks if the supplied tickler action code is valid.
- Calls the
RecordTicklerAction
task command to record the action on the tickler.
Exceptional conditions:
- Tickler ID is not supplied.
- Tickler action code is not supplied.
Default security policies:
- CSRs can execute this command.
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field and Description static java.lang.String
CLASSNAME
The name of this class.static java.lang.String
COPYRIGHT
The internal copyright field.-
Fields inherited from interface com.ibm.commerce.command.ECCommand
defaultCommandClassName
-
-
Constructor Summary
Constructors Constructor and Description TicklerActionRecordCmdImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description java.lang.String
getActionComment()
This method retrieves the tickler action comment(notes on the action).java.sql.Timestamp
getActionDate()
This method retrieves the timestamp of the tickler action.java.lang.Long
getAssignToMemberId()
This method retrieves the identifier of the Customer Service Representative(CSR) to whom this tickler is assigned.AccessVector
getResources()
This method retrieves the resources that are accessed by this command.java.lang.Integer
getTicklerActionId()
This method retrieves the tickler action code.java.lang.Long
getTicklerId()
This method returns the tickler identifier.java.lang.String
getURL()
This method returns the redirect URL.void
performExecute()
The business logic for this command that records a tickler action.void
reset()
This method resets all the command parameters.void
setActionComment(java.lang.String astrComment)
This method sets the tickler action comment (notes on the action).void
setActionDate(java.sql.Timestamp anActionDate)
This method sets the timestamp of the tickler action.void
setAssignToMemberId(java.lang.Long anAssignToMemberId)
The method sets the identifier of the Customer Service Representative(CSR) to whom this tickler is assigned.void
setRequestProperties(TypedProperty reqProperties)
This method sets the request properties.void
setTicklerActionId(java.lang.Integer anTicklerActionId)
This method is used to set the tickler action code.void
setTicklerId(java.lang.Long anTicklerId)
This method sets the tickler identifier.void
setURL(java.lang.String astrURL)
This method sets the redirect URL.void
validateParameters()
This method validates the command parameters.-
Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties
-
Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, isReadyToCallExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
-
Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache
-
Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl
getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties
-
Methods inherited from interface com.ibm.websphere.command.CacheableCommand
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache
-
Methods inherited from interface com.ibm.websphere.command.TargetableCommand
getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties
-
Methods inherited from interface com.ibm.commerce.command.AccCommand
accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner
-
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
-
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
-
-
-
-
Field Detail
-
COPYRIGHT
public static final java.lang.String COPYRIGHT
The internal copyright field.- See Also:
- Constant Field Values
-
CLASSNAME
public static final java.lang.String CLASSNAME
The name of this class.- See Also:
- Constant Field Values
-
-
Method Detail
-
getTicklerId
public java.lang.Long getTicklerId()
This method returns the tickler identifier. Tickler id is the unique number to identify the to-do item.- Returns:
- the tickler identifier.
-
setTicklerId
public void setTicklerId(java.lang.Long anTicklerId)
This method sets the tickler identifier. Tickler id is the unique number to identify the to-do item.- Parameters:
anTicklerId
- tickler identifier.
-
getTicklerActionId
public java.lang.Integer getTicklerActionId()
This method retrieves the tickler action code. A tickler action classifies work that is performed in an effort to resolve a tickler.- Returns:
- the tickler action code
-
setTicklerActionId
public void setTicklerActionId(java.lang.Integer anTicklerActionId)
This method is used to set the tickler action code. A tickler action classifies work that is performed in an effort to resolve a tickler.- Parameters:
anTicklerActionId
- tickler action code.
-
getURL
public java.lang.String getURL()
This method returns the redirect URL.- Returns:
- redirect URL
-
setURL
public void setURL(java.lang.String astrURL)
This method sets the redirect URL.- Parameters:
astrURL
- redirect URL.
-
getActionDate
public java.sql.Timestamp getActionDate()
This method retrieves the timestamp of the tickler action.- Returns:
- the timestamp of the tickler action.
-
setActionDate
public void setActionDate(java.sql.Timestamp anActionDate)
This method sets the timestamp of the tickler action.- Parameters:
anActionDate
- timestamp of the tickler action.
-
getAssignToMemberId
public java.lang.Long getAssignToMemberId()
This method retrieves the identifier of the Customer Service Representative(CSR) to whom this tickler is assigned.- Returns:
- the Customer Service Representative identifier.
-
setAssignToMemberId
public void setAssignToMemberId(java.lang.Long anAssignToMemberId)
The method sets the identifier of the Customer Service Representative(CSR) to whom this tickler is assigned.- Parameters:
anAssignToMemberId
- the Customer Service Representative(CSR) identifier.
-
getActionComment
public java.lang.String getActionComment()
This method retrieves the tickler action comment(notes on the action).- Returns:
- the tickler action comment.
-
setActionComment
public void setActionComment(java.lang.String astrComment)
This method sets the tickler action comment (notes on the action). A tickler action classifies work that is performed in an effort to resolve a tickler.- Parameters:
astrComment
- tickler action comment.
-
getResources
public AccessVector getResources() throws ECException
This method retrieves the resources that are accessed by this command.- Specified by:
getResources
in interfaceECCommand
- Overrides:
getResources
in classAbstractECTargetableCommand
- Returns:
- a vector of resource-action pairs.
- Throws:
com.ibm.commerce.exception.ECException.
ECException
-
performExecute
public void performExecute() throws ECException
The business logic for this command that records a tickler action.- Specified by:
performExecute
in interfaceECCommand
- Specified by:
performExecute
in interfacecom.ibm.websphere.command.TargetableCommand
- Overrides:
performExecute
in classAbstractECTargetableCommand
- Throws:
ECException
-
reset
public void reset()
This method resets all the command parameters.- Specified by:
reset
in interfacecom.ibm.websphere.command.Command
- Overrides:
reset
in classAbstractECTargetableCommand
-
setRequestProperties
public void setRequestProperties(TypedProperty reqProperties) throws ECApplicationException
This method sets the request properties. requestProperties provides additional methods for retrieving properties. It is wrapper tojava.util.Map
- Specified by:
setRequestProperties
in interfaceControllerCommand
- Overrides:
setRequestProperties
in classControllerCommandImpl
- Parameters:
reqProperties
- the request properties to be set.- Throws:
ECApplicationException
-
validateParameters
public void validateParameters() throws ECException
This method validates the command parameters.- Specified by:
validateParameters
in interfaceECCommand
- Overrides:
validateParameters
in classAbstractECTargetableCommand
- Throws:
ECException
-
-