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

Class AbstractQueryCommand

java.lang.Object

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

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

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

com.ptc.core.query.command.common.AbstractQueryCommand

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractReportQueryCommand, BasicQueryCommand

public abstract class AbstractQueryCommand
extends AbstractRepositoryCommand
implements Externalizable

This abstract class defines a command for all queries that use com.ptc.core.query services. The result, criteria and sort specifications are derived and must be implemented by subclasses.

Supported API: true

Extendable: false

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.ptc.core.command.common.bean.repository.AbstractRepositoryCommand

DEFAULT_REPOSITORY_SELECTOR

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
CriteriaAugmentor	getCriteriaAugmentor()	Gets the value of the attribute: criteriaAugmentor; this instance can be used to augment the query with additional criteria.
CriterionSpec	getCriteriaSpec()	Gets the value of the attribute: criterionSpec; this instance can be used to specify type based query criteria.
PageMode	getPageMode()	Gets the value of the attribute: pageMode; This attribute is an input that specifies the paging mode.
void	setCriteriaAugmentor(CriteriaAugmentor a_CriteriaAugmentor)	Sets the value of the attribute: criteriaAugmentor; this instance can be used to augment the query with additional criteria.
void	setCriteriaSpec(CriterionSpec a_CriteriaSpec)	Sets the value of the attribute: criterionSpec; this instance can be used to specify type based query criteria.
void	setPageMode(PageMode a_PageMode)	Sets the value of the attribute: pageMode; This attribute is an input that specifies the paging mode.

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

buildResultList, getCount, getObjectIdOffsetList, getOffset, getPagingSnapshotQueryLimit, getRepositorySelector, getRequestor, getResultContainer, getResultList, getResultSession, getSelectorTypename, readVersion, setCount, setObjectIdOffsetList, setOffset, setPagingSanpshotQueryLimit, setPagingSnapshotQueryLimit, setRepositorySelector, setResultContainer, setResultSession, setSort, toString

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

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

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

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

Methods inherited from class java.lang.Object

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

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

getFeedbackSpec, getLocale, getTargetLanguage, setFeedbackSpec, setLocale, setTargetLanguage

Method Details

getPageMode

public PageMode getPageMode()
                     throws UnsupportedOperationException

Gets the value of the attribute: pageMode; This attribute is an input that specifies the paging mode.

Supported API: true

Specified by:

getPageMode in interface RepositoryCommand

Overrides:

getPageMode in class AbstractRepositoryCommand

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.

Supported API: true

Specified by:

setPageMode in interface RepositoryCommand

Overrides:

setPageMode in class AbstractRepositoryCommand

Parameters:

a_PageMode -

Throws:

UnsupportedOperationException

WTPropertyVetoException

getCriteriaAugmentor

public CriteriaAugmentor getCriteriaAugmentor()

Gets the value of the attribute: criteriaAugmentor; this instance can be used to augment the query with additional criteria.

Supported API: true

Returns:

CriteriaAugmentor

setCriteriaAugmentor

public void setCriteriaAugmentor(CriteriaAugmentor a_CriteriaAugmentor)
                          throws WTPropertyVetoException

Sets the value of the attribute: criteriaAugmentor; this instance can be used to augment the query with additional criteria.

Supported API: true

Parameters:

a_CriteriaAugmentor -

Throws:

WTPropertyVetoException

getCriteriaSpec

public CriterionSpec getCriteriaSpec()

Gets the value of the attribute: criterionSpec; this instance can be used to specify type based query criteria.

Supported API: true

Returns:

CriterionSpec

setCriteriaSpec

public void setCriteriaSpec(CriterionSpec a_CriteriaSpec)
                     throws WTPropertyVetoException

Sets the value of the attribute: criterionSpec; this instance can be used to specify type based query criteria.

Supported API: true

Parameters:

a_CriteriaSpec -

Throws:

WTPropertyVetoException