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

Interface FetchAttachmentCmd

All Superinterfaces:

AbstractFetchNounCmd, com.ibm.websphere.command.Command, java.io.Serializable

All Known Implementing Classes:

AbstractFetchAttachmentCmdImpl, FetchAttachmentByIdCmdImpl, FetchAttachmentCmdImpl, FetchAttachmentForStoreCmdImpl

public interface FetchAttachmentCmd
extends AbstractFetchNounCmd

The command retrieves a list of attachments according to the search criteria specified by the client. The list contains AttachmentTargeDataBean objects populated with all the available data. The search criteria are specified by the input XPath queries.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.

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

serialVersionUID

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.
ShowType	getPagingParameter() This method gets the paging parameters
ShowType	getShow() Returns the show verb that represents the results returned.
void	setGet(GetType getVerb) This method sets the get expression to base the fetch operation on.
void	setGetAttachment(GetAttachmentType getAttachment) This method sets the GetAttachment.
void	setPagingParameter(ShowType aPagingParameter) This method sets the paging parameters

Methods inherited from interface com.ibm.commerce.foundation.server.command.bod.AbstractFetchNounCmd

getNouns, setSearchExpression

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

execute, isReadyToCallExecute, reset

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM Copyright notice field.

See Also:

Constant Field Values

Method Detail

getAttachments

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.

Returns:

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

setGetAttachment

void setGetAttachment(GetAttachmentType getAttachment)

This method sets the GetAttachment.

Parameters:

getAttachment - the GetAttachmentType to set

getPagingParameter

ShowType getPagingParameter()

This method gets the paging parameters

Returns:

ShowType

setPagingParameter

void setPagingParameter(ShowType aPagingParameter)

This method sets the paging parameters

Parameters:

aPagingParameter - The paging parameter to set.

getShow

ShowType getShow()

Returns the show verb that represents the results returned.

Specified by:

getShow in interface AbstractFetchNounCmd

Returns:

The show verb that corresponds with the results returned.

setGet

void setGet(GetType getVerb)

This method sets the get expression to base the fetch operation on.

Specified by:

setGet in interface AbstractFetchNounCmd

Parameters:

getVerb - The get expression to execute.