com.ibm.commerce.content.facade.server.commands

Class AbstractFetchManagedDirectoryCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.foundation.server.command.bod.AbstractFetchNounCmdImpl

com.ibm.commerce.content.facade.server.commands.AbstractFetchManagedDirectoryCmdImpl

All Implemented Interfaces:

FetchManagedDirectoryCmd, AbstractFetchNounCmd, 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

Direct Known Subclasses:

FetchManagedDirectoryCmdImpl

public abstract class AbstractFetchManagedDirectoryCmdImpl
extends AbstractFetchNounCmdImpl
implements FetchManagedDirectoryCmd

This command is the base command of those command that retrieve a list of managed directories according to the search criteria specified by the client.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.util.logging.Logger	LOGGER The logger of the class.

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
AbstractFetchManagedDirectoryCmdImpl()

Method Summary

Modifier and Type	Method and Description
GetManagedDirectoryType	getGetManagedDirectoryType() This method gets the value of GetManagedDirectoryType.
java.util.List	getManagedDirectories() Returns the list of ManagedDirectories that where retrieved when executing the fetch.
java.util.List	getManagedDirectories(java.util.List lstManagedDirectories, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems) This methods gets a certain number of managed directories.
java.util.List	getNouns() This method gets a list of managed directory nouns.
ShowType	getPagingParameter() This method gets the paging parameters
SelectionCriteriaMapper	getSelectionCriteria() This is a get method for SelectionCriteriaMapper;
boolean	isReadyToCallExecute() This method returns if this command is ready to execute
void	performExecute() This method is to get the result using the parameter of GetManagedDirectoryType by calling the Abstract method fetch().
void	reset() This method resets this command.
void	setGetManagedDirectory(GetManagedDirectoryType aGetManagedDirectory) This method sets the GetManagedDirectoryType.
void	setPagingParameter(ShowType aPagingParameter) This method set the paging parameters
void	setSelectionCriteria(SelectionCriteriaMapper aSelectionCriteria) This method is to set the SelectionCriteriaMapper.

Methods inherited from class com.ibm.commerce.foundation.server.command.bod.AbstractFetchNounCmdImpl

getShow, setGet, setSearchExpression

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

execute, executeFromCache, getCaller, getEntryInfo, getId, getObjectSize, 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.foundation.server.command.bod.AbstractFetchNounCmd

getShow, setGet, setSearchExpression

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

execute

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

getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

LOGGER

public static final java.util.logging.Logger LOGGER

The logger of the class.

Constructor Detail

AbstractFetchManagedDirectoryCmdImpl

public AbstractFetchManagedDirectoryCmdImpl()

Method Detail

isReadyToCallExecute

public boolean isReadyToCallExecute()

This method returns if this command is ready to execute

Specified by:

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

Overrides:

isReadyToCallExecute in class AbstractFetchNounCmdImpl

Returns:

boolean

See Also:

Command.isReadyToCallExecute()

performExecute

public void performExecute()
                    throws java.lang.Exception

This method is to get the result using the parameter of GetManagedDirectoryType by calling the Abstract method fetch().

Specified by:

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

Specified by:

performExecute in class com.ibm.websphere.command.TargetableCommandImpl

Throws:

java.lang.Exception

See Also:

TargetableCommandImpl.performExecute()

getManagedDirectories

public java.util.List getManagedDirectories(java.util.List lstManagedDirectories,
                                            java.math.BigInteger recordSetStartNumber,
                                            java.math.BigInteger maxItems)

This methods gets a certain number of managed directories.

Parameters:

lstManagedDirectories - a list of managed directories

recordSetStartNumber - record set start number

maxItems - the maximum of managed directories returned

Returns:

a list of managed directories

reset

public void reset()

This method resets this command.

Specified by:

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

Overrides:

reset in class AbstractFetchNounCmdImpl

See Also:

Command.reset()

getPagingParameter

public ShowType getPagingParameter()

This method gets the paging parameters

Specified by:

getPagingParameter in interface FetchManagedDirectoryCmd

Returns:

Returns the pagingParameter.

setPagingParameter

public void setPagingParameter(ShowType aPagingParameter)

This method set the paging parameters

Specified by:

setPagingParameter in interface FetchManagedDirectoryCmd

Parameters:

aPagingParameter - The paging parameter to set.

setGetManagedDirectory

public void setGetManagedDirectory(GetManagedDirectoryType aGetManagedDirectory)

This method sets the GetManagedDirectoryType.

Specified by:

setGetManagedDirectory in interface FetchManagedDirectoryCmd

Parameters:

aGetManagedDirectory - The GetManagedDirectoryType to be set which contains the parameters used to fetch.

getGetManagedDirectoryType

public GetManagedDirectoryType getGetManagedDirectoryType()

This method gets the value of GetManagedDirectoryType.

Returns:

GetManagedDirectoryType The GetManagedDirectoryType is gotten in this method.

getManagedDirectories

public java.util.List getManagedDirectories()

Returns the list of ManagedDirectories that where retrieved when executing the fetch.

Specified by:

getManagedDirectories in interface FetchManagedDirectoryCmd

Returns:

A list of ManagedDirectories that represents the results of executing the query expression.

getSelectionCriteria

public SelectionCriteriaMapper getSelectionCriteria()

This is a get method for SelectionCriteriaMapper;

Returns:

Returns the selectionCriteria.

setSelectionCriteria

public void setSelectionCriteria(SelectionCriteriaMapper aSelectionCriteria)

This method is to set the SelectionCriteriaMapper.

Parameters:

aSelectionCriteria - The SelectionCriteriaMapper to set.

getNouns

public java.util.List getNouns()

This method gets a list of managed directory nouns.

Specified by:

getNouns in interface AbstractFetchNounCmd

Returns:

a list of managed directory nouns.