com.ibm.commerce.tickler.commands

Class CreateTicklerCmdImpl

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

All Implemented Interfaces:

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

The class CreateTicklerCmdImpl creates a tickler based on an action object such as a quote or an order.

Behavior:

• Checks that if an action object's identifier is supplied, then so is its type, and vice-versa.
• Checks if the supplied action object identifier is valid for its type.
• If no remind-on date-time is supplied, sets the remind-on date-time to current date-time.
• If inAssignToMemberId is not specified, calls the DetermineAssignmentCmd task command to determine the assignee for a tickler.

Exceptional conditions:

• Of the action object identifier-type pair, only one is supplied.
• The tickler reason is not supplied.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASSNAME The name of this class.

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
CreateTicklerCmdImpl()

Method Summary

Modifier and Type	Method and Description
TicklerAccessBean	createTickler(java.lang.Integer storeId, java.lang.String actionObjectType, java.lang.Long actionObjectIndentifier, java.lang.Integer ticklerReasonIndentifier, java.lang.Long createdByUserIndentifier, java.lang.String comment, java.lang.Integer languageIdentifier, java.sql.Timestamp remindOnDate, java.lang.Long assignToMember, java.lang.Integer assignToRole) This method creates and returns a new tickler.
java.lang.Long	getActionObjectId() This method retrieves the identifier of the action object based on which this tickler is created.
java.lang.String	getActionObjectType() This method retrieves the type of the action object based on which this tickler is created.
java.lang.Long	getAssignToMemberId() This method returns the identifier of the Customer Service Representative(CSR) to whom this tickler is assigned.
java.lang.Integer	getAssignToRole() This method retrieves the Customer Service Representative(CSR) role to which the tickler is assigned.
java.sql.Timestamp	getRemindOnDate() This method retrieves the date-time when this tickler should next pop into the queue.
AccessVector	getResources() This method retrieves the resources that are accessed by this command.
java.lang.String	getTicklerComment() This method retrieves the tickler comment.
java.lang.Long	getTicklerId() This method retrieves the tickler identifier.
java.lang.Integer	getTicklerReasonId() This method retrieves the tickler reason identifier.
void	performExecute() This method contains the business logic for this command.
void	reset() This method resets all the command parameters.
void	setActionObjectId(java.lang.Long anActionObjectId) This method sets the identifier of the action object based on which this tickler is created.
void	setActionObjectType(java.lang.String astrActionObjectType) This method sets the type of the action object based on which this tickler is created.
void	setAssignToMemberId(java.lang.Long anAssignToMemberId) This method sets the identifier of the Customer Service Representative to whom this tickler is assigned.
void	setRemindOnDate(java.sql.Timestamp aRemindOnDate) This method sets the date-time when this tickler should next pop into the queue of the responsible member.
void	setRequestProperties(TypedProperty reqParms) This method sets the request properties.
void	setTicklerComment(java.lang.String astrComment) This method sets the tickler comment.
void	setTicklerReasonId(java.lang.Integer anTicklerReasonId) This method sets the tickler reason identifier.
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

CLASSNAME

public static final java.lang.String CLASSNAME

The name of this class.

See Also:

Constant Field Values

Constructor Detail

CreateTicklerCmdImpl

public CreateTicklerCmdImpl()

Method Detail

getTicklerComment

public java.lang.String getTicklerComment()

This method retrieves the tickler comment.

Specified by:

getTicklerComment in interface CreateTicklerCmd

Returns:

the tickler comment

setTicklerComment

public void setTicklerComment(java.lang.String astrComment)

This method sets the tickler comment.

Specified by:

setTicklerComment in interface CreateTicklerCmd

Parameters:

astrComment - text of the comment.

getTicklerReasonId

public java.lang.Integer getTicklerReasonId()

This method retrieves the tickler reason identifier. Tickler reason defines the purpose for a tickler.

Specified by:

getTicklerReasonId in interface CreateTicklerCmd

Returns:

the tickler reason identifier.

See Also:

createTickler

setTicklerReasonId

public void setTicklerReasonId(java.lang.Integer anTicklerReasonId)

This method sets the tickler reason identifier. Tickler reason defines the purpose for a tickler.

Specified by:

setTicklerReasonId in interface CreateTicklerCmd

Parameters:

anTicklerReasonId - tickler reason identifier.

See Also:

createTickler

getActionObjectId

public java.lang.Long getActionObjectId()

This method retrieves the identifier of the action object based on which this tickler is created. The action object are the types of object to which to-do item is associated. Valid values are as follows:

 ORDER=Order
 QUOTE=Quote
 RMA=Return
 USER=Customer
 

Specified by:

getActionObjectId in interface CreateTicklerCmd

Returns:

the action object identifier.

See Also:

createTickler

setActionObjectId

public void setActionObjectId(java.lang.Long anActionObjectId)

This method sets the identifier of the action object based on which this tickler is created. The action object are the types of object to which to-do item is associated. Valid values are as follows:

 ORDER=Order
 QUOTE=Quote
 RMA=Return
 USER=Customer
 

Specified by:

setActionObjectId in interface CreateTicklerCmd

Parameters:

anActionObjectId - action object identifier.

See Also:

createTickler

getActionObjectType

public java.lang.String getActionObjectType()

This method retrieves the type of the action object based on which this tickler is created. The action object types are the types of object to which to-do item is associated. Valid values are as follows:

 ORDER=Order
 QUOTE=Quote
 RMA=Return
 USER=Customer
 

Specified by:

getActionObjectType in interface CreateTicklerCmd

Returns:

the action object type.

See Also:

createTickler

setActionObjectType

public void setActionObjectType(java.lang.String astrActionObjectType)

This method sets the type of the action object based on which this tickler is created. The action object types are the types of object to which to-do item is associated. Valid values are as follows:

 ORDER=Order
 QUOTE=Quote
 RMA=Return
 USER=Customer
 

Specified by:

setActionObjectType in interface CreateTicklerCmd

Parameters:

astrActionObjectType - action object type.

See Also:

createTickler

getRemindOnDate

public java.sql.Timestamp getRemindOnDate()

This method retrieves the date-time when this tickler should next pop into the queue.

Specified by:

getRemindOnDate in interface CreateTicklerCmd

Returns:

the date-time when this tickler should next pop into the queue.

setRemindOnDate

public void setRemindOnDate(java.sql.Timestamp aRemindOnDate)

This method sets the date-time when this tickler should next pop into the queue of the responsible member.

Specified by:

setRemindOnDate in interface CreateTicklerCmd

Parameters:

aRemindOnDate - date-time when this tickler should next pop into the queue.

getAssignToMemberId

public java.lang.Long getAssignToMemberId()

This method returns the identifier of the Customer Service Representative(CSR) to whom this tickler is assigned.

Specified by:

getAssignToMemberId in interface CreateTicklerCmd

Returns:

the Customer Service Representative identifier.

setAssignToMemberId

public void setAssignToMemberId(java.lang.Long anAssignToMemberId)

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

Specified by:

setAssignToMemberId in interface CreateTicklerCmd

Parameters:

anAssignToMemberId - the Customer Service Representative identifier.

getResources

public AccessVector getResources()
                          throws ECException

This method retrieves 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

This method contains the 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

createTickler

public TicklerAccessBean createTickler(java.lang.Integer storeId,
                                       java.lang.String actionObjectType,
                                       java.lang.Long actionObjectIndentifier,
                                       java.lang.Integer ticklerReasonIndentifier,
                                       java.lang.Long createdByUserIndentifier,
                                       java.lang.String comment,
                                       java.lang.Integer languageIdentifier,
                                       java.sql.Timestamp remindOnDate,
                                       java.lang.Long assignToMember,
                                       java.lang.Integer assignToRole)
                                throws ECException

This method creates and returns a new tickler. A tickler reminds a Customer Service Supervisor or Customer Service Representative to perform an action. Example actions are calling a customer to get a replacement payment instruction or to review a price override.

Parameters:

storeId - the store identifier within which this tickler is of interest.

actionObjectType - the type of the action object with which this tickler is associated; for example, QUOTE or ORDER

actionObjectIndentifier - the internal reference number of the action object with which this tickler is associated.

ticklerReasonIndentifier - the code of the reason for this tickler.

createdByUserIndentifier - the identifier of the user who is creating this tickler.

comment - the comment to accompany this tickler.

languageIdentifier - the language identifier.

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

assignToMember - the identifier of the Customer Service Representative(CSR) to whom this tickler is to be assigned; if not supplied, assignToRole will be used.

assignToRole - the code of the Customer Service Representative(CSR) role to which the tickler is to be assigned if assignToMember is not supplied.

Returns:

tickler access bean.

Throws:

ECException

reset

public void reset()

This method resets 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. TypedProperties is a wrapper to a java.util.Map.

Specified by:

setRequestProperties in interface CreateTicklerCmd

Parameters:

reqParms - request properties.

Throws:

ECApplicationException

getTicklerId

public java.lang.Long getTicklerId()

This method retrieves the tickler identifier. Tickler id is the unique number to identify the to-do item.

Specified by:

getTicklerId in interface CreateTicklerCmd

Returns:

the tickler identifier.

getAssignToRole

public java.lang.Integer getAssignToRole()

This method retrieves the Customer Service Representative(CSR) role to which the tickler is assigned.

Returns:

role to which tickler is assigned to.