com.ibm.commerce.tickler.commands

Class TicklerLockCmdImpl

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

All Implemented Interfaces:

AccCommand, com.ibm.commerce.command.CacheableECCommand, ControllerCommand, ECCommand, ECTargetableCommand, TaskCommand, Protectable, TicklerLockCmd, 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 TicklerLockCmdImpl
extends ControllerCommandImpl
implements TicklerLockCmd

The class TicklerLockCmdImpl locks a tickler when a CSR is working on it.

Mandatory parameters: ticklerId, URL

Behavior:

1. Checks if the supplied tickler ID is valid and the tickler is not locked by another CSR.
2. Checks if the tickler is open.
3. Calls the LockTickler task command to lock the tickler.

Exceptional conditions:

• No tickler ID is supplied.
• The tickler has been closed.
• The tickler is already locked by another CSR.

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

Method Summary

Modifier and Type	Method and Description
AccessVector	getResources() This method retrieves the resources that are accessed by this command.
java.lang.Long	getTicklerId() This method retrieves the tickler identifier.
java.lang.String	getURL() This method retrieves the redirect URL.
void	performExecute() This method executes the business logic for this command.
void	reset() This method resets all the command parameters.
void	setRequestProperties(TypedProperty reqProperties) This method sets the request properties.
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.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

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

execute

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

accessControlCheck, getAccCheck, setAccCheck

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

TicklerLockCmdImpl

public TicklerLockCmdImpl()

Method Detail

getURL

public java.lang.String getURL()

This method retrieves the redirect URL.

Returns:

the redirect URL

setURL

public void setURL(java.lang.String astrURL)

This method sets the redirect URL.

Parameters:

astrURL - redirect URL.

getTicklerId

public java.lang.Long getTicklerId()

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

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 executes 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

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

setRequestProperties

public void setRequestProperties(TypedProperty reqProperties)
                          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 ControllerCommand

Overrides:

setRequestProperties in class ControllerCommandImpl

Parameters:

reqProperties - request properties.

Throws:

ECApplicationException

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