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:

  • Field Summary

    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
    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 com.ptc.core.command.common.bean.entity.AbstractPersistentEntityCommand

    readVersion

    Methods inherited from class com.ptc.core.command.common.bean.entity.AbstractEntityCommand

    getRequestor, getSource, readVersion, setResult, setSource, setSource

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

    getCommandContext, isExecutable, putOnCommandContext, readVersion, setCommandContext

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

    getLocale, getSelectorTypename, getTargetLanguage, readVersion, setLocale, setTargetLanguage

    Methods inherited from class java.lang.Object

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

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

    getLocale, getSelectorTypename, getTargetLanguage, setLocale, setTargetLanguage