Package 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

Fields

Modifier and Type	Field	Description
static final String	PAGE_MODE	Label for the attribute; This attribute is an input that specifies the paging mode.
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.
static final String	RESULT_SESSION	Label for the attribute; The Paging Session, if one has been established.
static final 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, OBJECT_ID_OFFSET_LIST, OFFSET

Method Summary

Modifier and Type	Method	Description
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.
SortSpec	getSort()	Gets the value of the attribute: SORT.
void	setPageMode(PageMode a_PageMode)	Sets the value of the attribute: PAGE_MODE.
void	setSort(SortSpec a_Sort)	Sets the value of the attribute: SORT.

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

getCount, getObjectIdOffsetList, getOffset, setCount, setObjectIdOffsetList, setOffset

Field Details

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 Details

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

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