CleanPageLayoutsCmdImpl

java.lang.Object
- MeasuredCacheableCommandImpl
- - com.ibm.commerce.command.AbstractECTargetableCommand
  - - com.ibm.commerce.command.ControllerCommandImpl
    - - com.ibm.commerce.pagelayout.commands.CleanPageLayoutsCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, CleanPageLayoutsCmd, Protectable, 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 CleanPageLayoutsCmdImpl
extends ControllerCommandImpl
implements CleanPageLayoutsCmd
```
This command finds the page layouts that are expired or marked for delete, and remove them from database. And also the web activities that are created while layout assignments, and the Marketing Spot and Content that are created while creating the widgets, will be deleted accordingly. This command should be scheduled to run periodically so that the system does not keep stale data for a long period of time.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM copyright notice 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.pagelayout.commands.CleanPageLayoutsCmd
  defaultCommandClassName
- Fields inherited from interface com.ibm.websphere.command.Command
  serialVersionUID

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field.

Constructor Summary

Constructors
Constructor and Description

CleanPageLayoutsCmdImpl()
Default constructor for this command.

Constructors
Constructor and Description
`CleanPageLayoutsCmdImpl()` Default constructor for this command.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`isGeneric()` This method returns false to indicate that this command cannot be run by a generic user.
`boolean`	`isReadyToCallExecute()` This method returns true to indicate that this command is ready to be executed.
`void`	`performExecute()` This method performs the main logic of this command.
`void`	`setRequestProperties(TypedProperty reqParms)` This method sets the command request properties.
`void`	`validateParameters()` This method extracts and validates the input parameters of the command implementation.

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, 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, 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, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

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

Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CleanPageLayoutsCmdImpl
```
public CleanPageLayoutsCmdImpl()
```
    Default constructor for this command.
- Method Detail
  - isReadyToCallExecute
```
public boolean isReadyToCallExecute()
```
    This method returns true to indicate that this command is ready to be executed.
    
    Specified by:
    
    isReadyToCallExecute in interface com.ibm.websphere.command.Command
    
    Overrides:
    
    isReadyToCallExecute in class AbstractECTargetableCommand
    
    Returns:
    
    The value with true.
  - performExecute
```
public void performExecute()
                    throws ECException
```
    This method performs the main logic of this command.
    - 1) Initializes the variable values to be used by the commands.
    - 2) Gets the layouts that need to be cleaned, including layouts that expired and marked for delete.
    - 3) Deleting the layouts and their related data from database, including:
      - The widgets associated activities & espot & content.
      - The web activities for layout assignment.
      - The page layout itself.
    Specified by:
    
    performExecute in interface ECCommand
    
    Specified by:
    
    performExecute in interface com.ibm.websphere.command.TargetableCommand
    
    Overrides:
    
    performExecute in class AbstractECTargetableCommand
    
    Throws:
    
    ECException
  - isGeneric
```
public boolean isGeneric()
```
    This method returns false to indicate that this command cannot be run by a generic user.
    
    Specified by:
    
    isGeneric in interface ControllerCommand
    
    Overrides:
    
    isGeneric in class ControllerCommandImpl
    
    Returns:
    
    The value with false.
  - setRequestProperties
```
public void setRequestProperties(TypedProperty reqParms)
                          throws ECApplicationException
```
    This method sets the command request properties.
    
    Specified by:
    
    setRequestProperties in interface ControllerCommand
    
    Overrides:
    
    setRequestProperties in class ControllerCommandImpl
    
    Parameters:
    
    reqParms - The type property of this command implementation.
    
    Throws:
    
    ECApplicationException
  - validateParameters
```
public void validateParameters()
                        throws ECException
```
    This method extracts and validates the input parameters of the command implementation.
    
    Specified by:
    
    validateParameters in interface ECCommand
    
    Overrides:
    
    validateParameters in class AbstractECTargetableCommand
    
    Throws:
    
    ECException

Class CleanPageLayoutsCmdImpl

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.pagelayout.commands.CleanPageLayoutsCmd

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

Constructor Detail

CleanPageLayoutsCmdImpl

Method Detail

isReadyToCallExecute

performExecute

isGeneric

setRequestProperties

validateParameters