Package com.ptc.core.command.common.bean.repository

Class BasicFetchPagingRepositoryCommand

java.lang.Object

com.ptc.core.command.common.bean.AbstractCommand

com.ptc.core.command.common.bean.AbstractServerCommand

com.ptc.core.command.common.bean.repository.AbstractPagingRepositoryCommand

com.ptc.core.command.common.bean.repository.BasicFetchPagingRepositoryCommand

All Implemented Interfaces:

PageRequest, RepositoryCommand, Command, com.ptc.core.command.common.ServerCommand, Externalizable, Serializable

public class BasicFetchPagingRepositoryCommand
extends AbstractPagingRepositoryCommand
implements RepositoryCommand, Externalizable

This command fetches a page of result data from an existing Paging Session.

Supported API: true

Extendable: false

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.ptc.core.command.common.bean.AbstractServerCommand

SERVER

Fields inherited from interface com.ptc.core.command.common.Command

FEEDBACK_SPEC, LOCALE

Fields inherited from interface com.ptc.core.command.common.bean.repository.PageRequest

COUNT, OBJECT_ID_OFFSET_LIST, OFFSET

Fields inherited from interface com.ptc.core.command.common.bean.repository.RepositoryCommand

PAGE_MODE, RESULT_CONTAINER, RESULT_SESSION, SORT

Fields inherited from interface com.ptc.core.command.common.ServerCommand

COMMAND_CONTEXT, CONTAINER_IDENTIFIER, FILTER

Method Summary

Modifier and Type	Method	Description
int	getCount()	Gets the value of the attribute: count; Number of items for the page.
int	getOffset()	Gets the value of the attribute: offset; Offset of the page.
ResultContainer	getResultContainer()	Gets the value of the attribute: resultContainer; The container of type instances that are a result of a command being executed against a repository.
RepositoryPagingSession	getResultSession()	Gets the value of the attribute: resultSession; The Paging Session, if one has been established.
SortSpec	getSort()	Gets the value of the attribute: sort; This attribute is an input that specifies the sort order of the result TypeInstances.
void	setCount(int a_Count)	Sets the value of the attribute: count; Number of items for the page.
void	setOffset(int a_Offset)	Sets the value of the attribute: offset; Offset of the page.
void	setSort(SortSpec a_Sort)	Sets the value of the attribute: sort; This attribute is an input that specifies the sort order of the result TypeInstances.

Methods inherited from class com.ptc.core.command.common.bean.repository.AbstractPagingRepositoryCommand

getRequestor, getSession, readVersion, setFilter, setSession

Methods inherited from class com.ptc.core.command.common.bean.AbstractServerCommand

execute, getCommandContext, getContainerIdentifier, isExecutable, putOnCommandContext, readVersion, setCommandContext, setContainerIdentifier

Methods inherited from class com.ptc.core.command.common.bean.AbstractCommand

getFeedbackSpec, getLocale, getSelectorTypename, getTargetLanguage, readVersion, setFeedbackSpec, setLocale, setTargetLanguage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ptc.core.command.common.Command

getFeedbackSpec, getLocale, getSelectorTypename, getTargetLanguage, setFeedbackSpec, setLocale, setTargetLanguage

Method Details

getOffset

public int getOffset()

Gets the value of the attribute: offset; Offset of the page.

Supported API: true

Specified by:

getOffset in interface PageRequest

Returns:

int

setOffset

public void setOffset(int a_Offset)
               throws WTPropertyVetoException

Sets the value of the attribute: offset; Offset of the page.

Supported API: true

Specified by:

setOffset in interface PageRequest

Parameters:

a_Offset -

Throws:

WTPropertyVetoException

getCount

public int getCount()

Gets the value of the attribute: count; Number of items for the page.

Supported API: true

Specified by:

getCount in interface PageRequest

Returns:

int

setCount

public void setCount(int a_Count)
              throws WTPropertyVetoException

Sets the value of the attribute: count; Number of items for the page.

Supported API: true

Specified by:

setCount in interface PageRequest

Parameters:

a_Count -

Throws:

WTPropertyVetoException

getResultContainer

public ResultContainer getResultContainer()

Gets the value of the attribute: resultContainer; The container of type instances that are a result of a command being executed against a repository.

Supported API: true

Specified by:

getResultContainer in interface RepositoryCommand

Returns:

ResultContainer

getResultSession

public RepositoryPagingSession getResultSession()
                                         throws UnsupportedOperationException

Gets the value of the attribute: resultSession; The Paging Session, if one has been established.

Supported API: true

Specified by:

getResultSession in interface RepositoryCommand

Returns:

RepositoryPagingSession

Throws:

UnsupportedOperationException

getSort

public SortSpec getSort()
                 throws UnsupportedOperationException,
WTException

Gets the value of the attribute: sort; This attribute is an input that specifies the sort order of the result TypeInstances. Its implementation is derived by more specialized commands that extend this class.

Supported API: true

Specified by:

getSort in interface RepositoryCommand

Returns:

SortSpec

Throws:

UnsupportedOperationException

WTException

setSort

public void setSort(SortSpec a_Sort)
             throws UnsupportedOperationException,
WTPropertyVetoException

Sets the value of the attribute: sort; This attribute is an input that specifies the sort order of the result TypeInstances. Its implementation is derived by more specialized commands that extend this class.

Supported API: true

Specified by:

setSort in interface RepositoryCommand

Parameters:

a_Sort -

Throws:

UnsupportedOperationException

WTPropertyVetoException