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

Class AttributeContainerQueryCommand

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

com.ptc.core.query.command.common.BasicQueryCommand

com.ptc.core.query.command.common.AttributeContainerQueryCommand

All Implemented Interfaces:

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

public class AttributeContainerQueryCommand
extends BasicQueryCommand
implements Externalizable

This class provies a query implementation based on the contents of an AttributeContainer. The results, criteria, and sort specifications are derived from the input AttributeContainer.

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
TypeIdentifier[]	getExcludedTypes()	Gets the value of the attribute: excludedTypes; An optional list of types that will be excluded from the results.
AttributeContainer	getInputContainer()	Gets the value of the attribute: inputContainer; The input attribute container that will be used as the basis of the query.
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	setInputContainer(AttributeContainer a_InputContainer)	Sets the value of the attribute: inputContainer; The input attribute container that will be used as the basis of the query.

Methods inherited from class com.ptc.core.query.command.common.BasicQueryCommand

appendCriteria, getResult, getSort, readVersion, setCriteria, setResult, setSort

Methods inherited from class com.ptc.core.query.command.common.AbstractQueryCommand

buildCriteriaSpec, getCriteriaAugmentor, getCriteriaSpec, getFilter, getFilterAttribute, getPageMode, readVersion, setCriteriaAugmentor, setCriteriaSpec, setPageMode

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

buildResultList, getCount, getObjectIdOffsetList, getOffset, getPagingSnapshotQueryLimit, getRepositorySelector, getResultContainer, getResultList, getResultSession, readVersion, setCount, setObjectIdOffsetList, setOffset, setPagingSanpshotQueryLimit, setPagingSnapshotQueryLimit, setRepositorySelector, setResultContainer, setResultSession, 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

getInputContainer

public AttributeContainer getInputContainer()
                                     throws UnsupportedOperationException

Gets the value of the attribute: inputContainer; The input attribute container that will be used as the basis of the query.

Supported API: true

Returns:

AttributeContainer

Throws:

UnsupportedOperationException

setInputContainer

public void setInputContainer(AttributeContainer a_InputContainer)
                       throws UnsupportedOperationException,
WTPropertyVetoException,
CommandException

Sets the value of the attribute: inputContainer; The input attribute container that will be used as the basis of the query.

Supported API: true

Parameters:

a_InputContainer -

Throws:

UnsupportedOperationException

WTPropertyVetoException

CommandException

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