Package com.ptc.core.query.command.common

Class FindPersistentEntityCommand

java.lang.Object

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

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

com.ptc.core.command.common.bean.entity.AbstractEntityCommand

com.ptc.core.command.common.bean.entity.AbstractPersistentEntityCommand

com.ptc.core.query.command.common.FindPersistentEntityCommand

All Implemented Interfaces:

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

public class FindPersistentEntityCommand
extends com.ptc.core.command.common.bean.entity.AbstractPersistentEntityCommand
implements RepositoryCommand, Externalizable

This Command executes a query derived from the values int the source TypeInstance.

Supported API: true

Extendable: false

See Also:

• Serialized Form

Field Summary

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

COUNT, OFFSET

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

PAGE_MODE, RESULT_CONTAINER, RESULT_SESSION, SORT

Method Summary

Modifier and Type	Method	Description
Command	execute()	Supported API: true
int	getCount()	Gets the value of the attribute: count; Number of items for the page.
TypeIdentifier[]	getExcludedTypes()	Gets the value of the attribute: excludedTypes; An optional list of types that will be excluded from the results.
int	getOffset()	Gets the value of the attribute: offset; Offset of the page.
PageMode	getPageMode()	Gets the value of the attribute: pageMode; This attribute is an input that specifies the paging mode.
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.
TypeInstance[]	getResultList()	Supported API: true
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	setExcludedTypes(TypeIdentifier[] a_ExcludedTypes)	Sets the value of the attribute: excludedTypes; An optional list of types that will be excluded from the results.
void	setOffset(int a_Offset)	Sets the value of the attribute: offset; Offset of the page.
void	setPageMode(PageMode a_PageMode)	Sets the value of the attribute: pageMode; This attribute is an input that specifies the paging mode.
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.
void	setSource(TypeInstance a_Source)	Supported API: true

Methods inherited from class java.lang.Object

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

Method Details

getExcludedTypes

public TypeIdentifier[] getExcludedTypes()

Gets the value of the attribute: excludedTypes; An optional list of types that will be excluded from the results.

Supported API: true

Returns:

TypeIdentifier[]

setExcludedTypes

public void setExcludedTypes(TypeIdentifier[] a_ExcludedTypes)
                      throws WTPropertyVetoException

Sets the value of the attribute: excludedTypes; An optional list of types that will be excluded from the results.

Supported API: true

Parameters:

a_ExcludedTypes -

Throws:

WTPropertyVetoException

setSource

public void setSource(TypeInstance a_Source)
               throws UnsupportedOperationException,
WTPropertyVetoException

Supported API: true

Overrides:

setSource in class com.ptc.core.command.common.bean.entity.AbstractEntityCommand

Parameters:

a_Source -

Throws:

UnsupportedOperationException

WTPropertyVetoException

execute

public Command execute()
                throws CommandException

Supported API: true

Specified by:

execute in interface Command

Overrides:

execute in class com.ptc.core.command.common.bean.AbstractServerCommand

Returns:

Command

Throws:

CommandException

getResultList

public TypeInstance[] getResultList()

Supported API: true

Specified by:

getResultList in interface com.ptc.core.command.common.ServerCommand

Overrides:

getResultList in class com.ptc.core.command.common.bean.entity.AbstractEntityCommand

Returns:

TypeInstance[]

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

getPageMode

public PageMode getPageMode()
                     throws UnsupportedOperationException

Gets the value of the attribute: pageMode; 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

Specified by:

getPageMode in interface RepositoryCommand

Returns:

PageMode

Throws:

UnsupportedOperationException

setPageMode

public void setPageMode(PageMode a_PageMode)
                 throws UnsupportedOperationException,
WTPropertyVetoException

Sets the value of the attribute: pageMode; 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

Specified by:

setPageMode in interface RepositoryCommand

Parameters:

a_PageMode -

Throws:

UnsupportedOperationException

WTPropertyVetoException

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