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

Class BasicQueryCommand

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AttributeContainerQueryCommand

public class BasicQueryCommand
extends AbstractQueryCommand
implements Externalizable

This class provies a basic implementation of a query comand the results, criteria, and sort specifications are implemented as simple attributes with setters and getters.

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
void	appendCriteria(AttributeContainerSet a_criteria, boolean a_union)	Appends the specified criteria to the existing criteria.
AttributeContainerSet	getCriteria()	Gets the value of the attribute: criteria; Specifies the criteria that "filters" TypeInstances returned in the query.
ResultSpec	getResult()	Gets the value of the attribute: result; Specificies the list of AttributeTypeIdentifiers that are to be included in the results.
SortSpec	getSort()	Gets the value of the attribute: sort; Specifies the TypeInstance sort order.
void	setCriteria(AttributeContainerSet a_Criteria)	Sets the value of the attribute: criteria; Specifies the criteria that "filters" TypeInstances returned in the query.
void	setResult(ResultSpec a_Result)	Sets the value of the attribute: result; Specificies the list of AttributeTypeIdentifiers that are to be included in the results.
void	setSort(SortSpec a_Sort)	Sets the value of the attribute: sort; Specifies the TypeInstance sort order.

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

getCriteriaAugmentor, getCriteriaSpec, getPageMode, setCriteriaAugmentor, setCriteriaSpec, setPageMode

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

getCount, getOffset, getResultContainer, getResultList, getResultSession, setCount, setOffset

Methods inherited from class java.lang.Object

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

Method Details

getSort

public SortSpec getSort()
                 throws WTException

Gets the value of the attribute: sort; Specifies the TypeInstance sort order.

Supported API: true

Specified by:

getSort in interface RepositoryCommand

Specified by:

getSort in class AbstractQueryCommand

Returns:

SortSpec

Throws:

WTException

setSort

public void setSort(SortSpec a_Sort)
             throws WTPropertyVetoException

Sets the value of the attribute: sort; Specifies the TypeInstance sort order.

Supported API: true

Specified by:

setSort in interface RepositoryCommand

Overrides:

setSort in class AbstractRepositoryCommand

Parameters:

a_Sort -

Throws:

WTPropertyVetoException

getCriteria

public AttributeContainerSet getCriteria()
                                  throws WTException

Gets the value of the attribute: criteria; Specifies the criteria that "filters" TypeInstances returned in the query.

Supported API: true

Specified by:

getCriteria in class AbstractQueryCommand

Returns:

AttributeContainerSet

Throws:

WTException

setCriteria

public void setCriteria(AttributeContainerSet a_Criteria)
                 throws WTPropertyVetoException

Sets the value of the attribute: criteria; Specifies the criteria that "filters" TypeInstances returned in the query.

Supported API: true

Parameters:

a_Criteria -

Throws:

WTPropertyVetoException

getResult

public ResultSpec getResult()
                     throws WTException

Gets the value of the attribute: result; Specificies the list of AttributeTypeIdentifiers that are to be included in the results.

Supported API: true

Specified by:

getResult in class AbstractQueryCommand

Returns:

ResultSpec

Throws:

WTException

setResult

public void setResult(ResultSpec a_Result)
               throws WTPropertyVetoException

Sets the value of the attribute: result; Specificies the list of AttributeTypeIdentifiers that are to be included in the results.

Supported API: true

Parameters:

a_Result -

Throws:

WTPropertyVetoException

appendCriteria

public void appendCriteria(AttributeContainerSet a_criteria,
 boolean a_union)
                    throws WTException

Appends the specified criteria to the existing criteria.

Supported API: true

Parameters:

a_criteria - criteria instance to append

a_union - Indicates if the criteria should be a union (i.e. logical OR) or and intersection (i.e. logical AND).

Throws:

WTException