com.ptc.core.command.common.bean.repository
Interface RepositoryCommand

All Superinterfaces:

PageRequest

All Known Implementing Classes:

AbstractQueryCommand, AbstractReportQueryCommand, AbstractRepositoryCommand, AttributeContainerQueryCommand, BasicFetchPagingRepositoryCommand, BasicQueryCommand, BasicReportQueryCommand, FindPersistentEntityCommand, PersistedReportQueryCommand

public interface RepositoryCommand
extends PageRequest

This interface specifies a command for retrieving data results from a repository of data. A repository could store data in a variety of forms such as database, flat file, legacay API interface, etc.

Supported API: true

Extendable: false

Field Summary

static String	PAGE_MODE Label for the attribute; This attribute is an input that specifies the paging mode.
static String	RESULT_CONTAINER Label for the attribute; The container of type instances that are a result of a command being executed against a repository.
static String	RESULT_SESSION Label for the attribute; The Paging Session, if one has been established.
static String	SORT Label for the attribute; This attribute is an input that specifies the sort order of the result TypeInstances.

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

COUNT, OFFSET

Method Summary

PageMode	getPageMode() Gets the value of the attribute: PAGE_MODE.
ResultContainer	getResultContainer() Gets the value of the attribute: RESULT_CONTAINER.
RepositoryPagingSession	getResultSession() Gets the value of the attribute: RESULT_SESSION.
com.ptc.core.meta.common.SortSpec	getSort() Gets the value of the attribute: SORT.
void	setPageMode(PageMode a_PageMode) Sets the value of the attribute: PAGE_MODE.
void	setSort(com.ptc.core.meta.common.SortSpec a_Sort) Sets the value of the attribute: SORT.

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

getCount, getOffset, setCount, setOffset

Field Detail

RESULT_CONTAINER

static final String RESULT_CONTAINER

Label for the attribute; The container of type instances that are a result of a command being executed against a repository.

Supported API: true

See Also:

Constant Field Values

RESULT_SESSION

static final String RESULT_SESSION

Label for the attribute; The Paging Session, if one has been established.

Supported API: true

See Also:

Constant Field Values

SORT

static final String SORT

Label for the attribute; 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

See Also:

Constant Field Values

PAGE_MODE

static final String PAGE_MODE

Label for the attribute; This attribute is an input that specifies the paging mode. Its implementation is derived by more specialized commands that extend this class.

Supported API: true

See Also:

Constant Field Values

Method Detail

getResultContainer

ResultContainer getResultContainer()

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

Supported API: true

Returns:

ResultContainer

getResultSession

RepositoryPagingSession getResultSession()
                                         throws UnsupportedOperationException

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

Supported API: true

Returns:

RepositoryPagingSession

Throws:

UnsupportedOperationException

getSort

com.ptc.core.meta.common.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

Returns:

SortSpec

Throws:

UnsupportedOperationException

WTException

setSort

void setSort(com.ptc.core.meta.common.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

Parameters:

a_Sort -

Throws:

UnsupportedOperationException

WTPropertyVetoException

getPageMode

PageMode getPageMode()
                     throws UnsupportedOperationException

Gets the value of the attribute: PAGE_MODE. This attribute is an input that specifies the paging mode. Its implementation is derived by more specialized commands that extend this class.

Supported API: true

Returns:

PageMode

Throws:

UnsupportedOperationException

setPageMode

void setPageMode(PageMode a_PageMode)
                 throws UnsupportedOperationException,
                        WTPropertyVetoException

Sets the value of the attribute: PAGE_MODE. This attribute is an input that specifies the paging mode. Its implementation is derived by more specialized commands that extend this class.

Supported API: true

Parameters:

a_PageMode -

Throws:

UnsupportedOperationException

WTPropertyVetoException