TicklerUnlockMonitorCmdImpl

java.lang.Object
- MeasuredCacheableCommandImpl
- - com.ibm.commerce.command.AbstractECTargetableCommand
  - - com.ibm.commerce.command.ControllerCommandImpl
    - - com.ibm.commerce.tickler.commands.TicklerUnlockMonitorCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, Protectable, TicklerUnlockMonitorCmd, 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 TicklerUnlockMonitorCmdImpl
extends ControllerCommandImpl
implements TicklerUnlockMonitorCmd
```
The class TicklerUnlockMonitorCmdImpl unlocks ticklers that have been locked longer than a specified period of time (for example, four hours).Invoked by a scheduled job.
Mandatory parameters: storeId

Optional parameters: inUnlockAfterNumberOfHours, URL

Behavior:
1. Finds all ticklers that have been locked longer than the specified period of time.
2. Calls the UnlockTickler task command to unlock them.
Exceptional conditions:
- Store ID is not a valid integer value.

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.commerce.command.ControllerCommandImpl
  requestProperties, responseProperties, retriable, viewReqProperties
- Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
  commandContext
- Fields inherited from interface com.ibm.commerce.command.ECCommand
  defaultCommandClassName
- Fields inherited from interface com.ibm.websphere.command.Command
  serialVersionUID

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.

Constructor Summary

Constructors
Constructor and Description

TicklerUnlockMonitorCmdImpl()

Constructors
Constructor and Description
`TicklerUnlockMonitorCmdImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`AccessVector`	`getResources()` This method retrieves the resources that are accessed by this command.
`java.lang.Integer`	`getUnlockAfterNumberOfHours()` This method retrieves the number of hours after which a locked tickler is to be unlocked.
`java.lang.String`	`getURL()` This method retrieves the value of 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`	`setUnlockAfterNumberOfHours(java.lang.Integer anUnlockAfterNumberOfHours)` This method sets the number of hours after which a locked tickler is to be unlocked.
`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 java.lang.Object
clone, equals, finalize, 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.websphere.command.CommandCaller
unionDependencies

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

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
- Constructor Detail
  - TicklerUnlockMonitorCmdImpl
```
public TicklerUnlockMonitorCmdImpl()
```
- Method Detail
  - getURL
```
public java.lang.String getURL()
```
    This method retrieves the value of redirect URL.
    
    Returns:
    
    the value of redirect URL.
  - setURL
```
public void setURL(java.lang.String astrURL)
```
    This method sets the redirect URL.
    
    Parameters:
    
    astrURL - redirect URL.
  - getUnlockAfterNumberOfHours
```
public java.lang.Integer getUnlockAfterNumberOfHours()
```
    This method retrieves the number of hours after which a locked tickler is to be unlocked.
    
    Returns:
    
    the number of hours after which a locked tickler is to be unlocked.
  - setUnlockAfterNumberOfHours
```
public void setUnlockAfterNumberOfHours(java.lang.Integer anUnlockAfterNumberOfHours)
```
    This method sets the number of hours after which a locked tickler is to be unlocked.
    
    Parameters:
    
    anUnlockAfterNumberOfHours - the number of hours after which a locked tickler is to be unlocked.
  - 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 - the 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

Class TicklerUnlockMonitorCmdImpl

Field Summary

Fields inherited from class com.ibm.commerce.command.ControllerCommandImpl

Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

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

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

Constructor Summary

Method Summary

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Methods inherited from class java.lang.Object

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

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

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

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

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

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

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

Methods inherited from interface com.ibm.commerce.security.Protectable

Field Detail

COPYRIGHT

CLASSNAME

Constructor Detail

TicklerUnlockMonitorCmdImpl

Method Detail

getURL

setURL

getUnlockAfterNumberOfHours

setUnlockAfterNumberOfHours

getResources

performExecute

reset

setRequestProperties

validateParameters