com.ibm.commerce.tickler.commands

Class RecordTicklerActionCmdImpl

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.TaskCommandImpl

com.ibm.commerce.tickler.commands.RecordTicklerActionCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, RecordTicklerActionCmd, 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 RecordTicklerActionCmdImpl
extends TaskCommandImpl
implements RecordTicklerActionCmd

The class RecordTicklerActionCmdImpl records the CSR action on a list of ticklers, closing those ticklers for which the action is a resolving action.

Behavior:

1. Checks if the supplied tickler identifiers are valid.
2. Checks if the supplied tickler action code is valid.
3. For each tickler in the list:
   1. Records the CSR action.
   2. If the action is a resolving action, sets status of the tickler to closed.
   3. Determines the new remind-on date-time.
   4. Calls the UpdateTickler task command to update the remind-on date-time and assignee if needed.

Exceptional conditions:

• Tickler ID list 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 class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.command.CacheableECCommand

defaultCommandClassName

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
RecordTicklerActionCmdImpl()

Method Summary

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 is used to retrieve the timestamp of the tickler action.
java.lang.Long	getAssignToMemberId() This method retrieves the identifier of the Customer Service Representative to whom this tickler is assigned.
AccessVector	getResources() This method returns the resources that are accessed by this command.
java.lang.Integer	getTicklerActionId() This method retrieves the tickler action code.
java.lang.Long[]	getTicklerIds() This method is used to retrieve the list of tickler identifiers.
boolean	getUnassigned() This method returns a boolean flag that determines whether the tickler is to be assigned to a member or not.
void	performExecute() The method executes business logic for this command.
void	reset() This method is used to reset 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) This method is used to sets the identifier of the Customer Service Representative to whom this tickler is assigned.
void	setRequestProperties(TypedProperty reqParms) This method sets the request properties.
void	setTicklerActionId(java.lang.Integer anTicklerActionId) This method sets the tickler action code.
void	setTicklerIds(java.lang.Long[] aarrnTickler) This method sets the list of tickler identifiers.
void	setUnassigned(boolean inUnassignedValue) This method sets the boolean flag that determines whether the tickler is to be assigned to a member or not.
void	updateTickler(java.lang.Long ticklerId, java.sql.Timestamp remindOnDate, java.lang.Short status, boolean unassigned, java.lang.Long assignToMember) This method is used to update an existing tickler.
void	validateParameters() This method validates the command parameters.

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.CacheableECCommand

execute

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.websphere.command.Command

isReadyToCallExecute

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

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

Constructor Detail

RecordTicklerActionCmdImpl

public RecordTicklerActionCmdImpl()

Method Detail

getTicklerIds

public java.lang.Long[] getTicklerIds()

This method is used to retrieve the list of tickler identifiers. Tickler id is the unique number to identify the to-do item.

Specified by:

getTicklerIds in interface RecordTicklerActionCmd

Returns:

array of tickler identifiers.

setTicklerIds

public void setTicklerIds(java.lang.Long[] aarrnTickler)

This method sets the list of tickler identifiers. Tickler id is the unique number to identify the to-do item.

Specified by:

setTicklerIds in interface RecordTicklerActionCmd

Parameters:

aarrnTickler - array of tickler identifiers.

getActionComment

public java.lang.String getActionComment()

This method retrieves the tickler action comment (notes on the action). A tickler action classifies work that is performed in an effort to resolve a tickler.

Specified by:

getActionComment in interface RecordTicklerActionCmd

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.

Specified by:

setActionComment in interface RecordTicklerActionCmd

Parameters:

astrComment - tickler action comment.

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.

Specified by:

getTicklerActionId in interface RecordTicklerActionCmd

Returns:

the tickler action code.

setTicklerActionId

public void setTicklerActionId(java.lang.Integer anTicklerActionId)

This method sets the tickler action code. A tickler action classifies work that is performed in an effort to resolve a tickler.

Specified by:

setTicklerActionId in interface RecordTicklerActionCmd

Parameters:

anTicklerActionId - tickler action code.

getActionDate

public java.sql.Timestamp getActionDate()

This method is used to retrieve the timestamp of the tickler action.

Specified by:

getActionDate in interface RecordTicklerActionCmd

Returns:

the timestamp of the tickler action.

setActionDate

public void setActionDate(java.sql.Timestamp anActionDate)

This method sets the timestamp of the tickler action.

Specified by:

setActionDate in interface RecordTicklerActionCmd

Parameters:

anActionDate - timestamp of the tickler action.

getAssignToMemberId

public java.lang.Long getAssignToMemberId()

This method retrieves the identifier of the Customer Service Representative to whom this tickler is assigned.

Specified by:

getAssignToMemberId in interface RecordTicklerActionCmd

Returns:

the Customer Service Representative identifier.

setAssignToMemberId

public void setAssignToMemberId(java.lang.Long anAssignToMemberId)

This method is used to sets the identifier of the Customer Service Representative to whom this tickler is assigned.

Specified by:

setAssignToMemberId in interface RecordTicklerActionCmd

Parameters:

anAssignToMemberId - the Customer Service Representative identifier.

getUnassigned

public boolean getUnassigned()

This method returns a boolean flag that determines whether the tickler is to be assigned to a member or not.

Specified by:

getUnassigned in interface RecordTicklerActionCmd

Returns:

true if the tickler is not to be assigned; false otherwise

setUnassigned

public void setUnassigned(boolean inUnassignedValue)

This method sets the boolean flag that determines whether the tickler is to be assigned to a member or not.

Specified by:

setUnassigned in interface RecordTicklerActionCmd

Parameters:

inUnassignedValue - true if the tickler is not to be assigned; false otherwise.

getResources

public AccessVector getResources()
                          throws ECException

This method returns the resources that are accessed by this command.

Specified by:

getResources in interface ECCommand

Overrides:

getResources in class AbstractECTargetableCommand

Returns:

a vector of resource-action pairs.

Throws:

ECException

performExecute

public void performExecute()
                    throws ECException

The method executes business logic for this command.

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException

updateTickler

public void updateTickler(java.lang.Long ticklerId,
                          java.sql.Timestamp remindOnDate,
                          java.lang.Short status,
                          boolean unassigned,
                          java.lang.Long assignToMember)
                   throws ECException

This method is used to update an existing tickler.

Parameters:

ticklerId - the identifier of the tickler to be updated.

remindOnDate - the date-time when this tickler should show up in the tickler queue; if not supplied, the current date-time will be used.

status - the status of this tickler (0 for open, 1 for closed).

unassigned - the flag to indicate whether the tickler is to be assigned: true if it is not to be assigned, in which case assignToMember will be ignored; false otherwise.

assignToMember - the ID of the CSR to whom this tickler is to be assigned.

Throws:

ECException

reset

public void reset()

This method is used to reset all the command parameters.

Specified by:

reset in interface com.ibm.websphere.command.Command

Overrides:

reset in class AbstractECTargetableCommand

validateParameters

public void validateParameters()
                        throws ECException

This method validates the command parameters.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException

setRequestProperties

public void setRequestProperties(TypedProperty reqParms)
                          throws ECApplicationException

This method sets the request properties. requestProperties provides additional methods for retrieving properties. It is wrapper to java.util.Map.

Specified by:

setRequestProperties in interface RecordTicklerActionCmd

Parameters:

reqParms - request properties.

Throws:

ECApplicationException