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

Class AbstractFetchAttachmentCmdImpl

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

All Implemented Interfaces:

FetchAttachmentCmd, 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:

FetchAttachmentByIdCmdImpl, FetchAttachmentCmdImpl, FetchAttachmentForStoreCmdImpl

public abstract class AbstractFetchAttachmentCmdImpl
extends AbstractFetchNounCmdImpl
implements FetchAttachmentCmd

This command is the base command of those commands that retrieve a list of attachments according to the search criteria specified by the client. The list contains AttachmentTargeDataBean objects populated with all the available data.

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

Method Summary

Modifier and Type	Method and Description
java.util.List	getAttachments() This method returns a list of Attachments as the result of the fetch operation.
GetAttachmentType	getGetAttachment() This method gets the value of GetAttachmentType.
java.util.List	getNouns() This method returns the list of nouns that have been retrieved by the business object manager that matches the specified XPath expression.
ShowType	getPagingParameter() This method gets the paging parameters
ShowType	getShow() This method returns the show verb response that represent the results of the fetch operation.
ShowAttachmentDataAreaType	getShowAttachmentDataArea() This method returns the attachment show data.
boolean	isReadyToCallExecute() This method returns whether the command has the get verb specified so it is ready to execute.
void	performExecute() This method calls the method performSearch() to search the attachments in FetchAttachment commands.
void	reset() This method resets the instance variables so the command can be reused.
void	setGet(GetType getVerb) This method sets the get expression for the fetch operation.
void	setGetAttachment(GetAttachmentType getAttachment) This method sets the value of GetAttachmentType.
void	setPagingParameter(ShowType aPagingParameter) This method set the paging parameters

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

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

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

AbstractFetchAttachmentCmdImpl

public AbstractFetchAttachmentCmdImpl()

Method Detail

isReadyToCallExecute

public boolean isReadyToCallExecute()

Description copied from class: AbstractFetchNounCmdImpl

This method returns whether the command has the get verb specified so it is ready to execute.

Specified by:

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

Overrides:

isReadyToCallExecute in class AbstractFetchNounCmdImpl

Returns:

Whether the command can execute or not.

See Also:

Command.isReadyToCallExecute()

reset

public void reset()

Description copied from class: AbstractFetchNounCmdImpl

This method resets the instance variables so the command can be reused.

Specified by:

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

Overrides:

reset in class AbstractFetchNounCmdImpl

See Also:

Command.reset()

setGetAttachment

public void setGetAttachment(GetAttachmentType getAttachment)

This method sets the value of GetAttachmentType.

Specified by:

setGetAttachment in interface FetchAttachmentCmd

Parameters:

getAttachment -

getGetAttachment

public GetAttachmentType getGetAttachment()

This method gets the value of GetAttachmentType.

Returns:

the value of GetAttachmentType

getAttachments

public java.util.List getAttachments()

This method returns a list of Attachments as the result of the fetch operation. The list contains AttachmentTargeDataBean objects populated with all available data.

Specified by:

getAttachments in interface FetchAttachmentCmd

Returns:

A list of AttachmentTargeDataBean objects populated with all the available data.

See Also:

FetchAttachmentCmd.getAttachments()

getPagingParameter

public ShowType getPagingParameter()

This method gets the paging parameters

Specified by:

getPagingParameter in interface FetchAttachmentCmd

Returns:

Returns the pagingParameter.

setPagingParameter

public void setPagingParameter(ShowType aPagingParameter)

This method set the paging parameters

Specified by:

setPagingParameter in interface FetchAttachmentCmd

Parameters:

aPagingParameter - The paging parameter to set.

performExecute

public final void performExecute()
                          throws java.lang.Exception

This method calls the method performSearch() to search the attachments in FetchAttachment commands. Then it calls ComposeAttachmentCmd to compose the attachment logical noun.

Specified by:

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

Specified by:

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

Throws:

java.lang.Exception

getShow

public ShowType getShow()

This method returns the show verb response that represent the results of the fetch operation.

Specified by:

getShow in interface FetchAttachmentCmd

Specified by:

getShow in interface AbstractFetchNounCmd

Overrides:

getShow in class AbstractFetchNounCmdImpl

Returns:

The show verb response.

See Also:

FetchCatalogCmd.getShow()

setGet

public void setGet(GetType getVerb)

This method sets the get expression for the fetch operation. The get expression will contain the details of the xpath request. The get expression also can contain the paging parameters.

Specified by:

setGet in interface FetchAttachmentCmd

Specified by:

setGet in interface AbstractFetchNounCmd

Overrides:

setGet in class AbstractFetchNounCmdImpl

Parameters:

getVerb - The get expression.

See Also:

FetchCatalogCmd.setGet(com.ibm.commerce.oagis9.datatypes.GetType)

getShowAttachmentDataArea

public ShowAttachmentDataAreaType getShowAttachmentDataArea()

This method returns the attachment show data.

Returns:

the ShowAttachmentDataAreaType which contains all the category information to be displayed.

getNouns

public java.util.List getNouns()

This method returns the list of nouns that have been retrieved by the business object manager that matches the specified XPath expression.

Specified by:

getNouns in interface AbstractFetchNounCmd

Returns:

The list of nouns that represent the XPath expression.