public interface HierarchySearchSession extends HierarchyQuerySession
This session provides methods for searching among Hierarchy
objects. The search query is constructed using the
HierarchyQuery.
getHierarchiesByQuery()
is the basic search method and
returns a list of Hierarchy
objects. A more advanced search
may be performed with getHierarchiesBySearch().
It accepts
a HierarchySearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
ordering. getHierarchiesBySearch()
returns a
HierarchySearchResults
that can be used to access the resulting
HierarchyList
or be used to perform a search within the
result set through HierarchySearch.
Hierarchies may have a query record indicated by their respective
record types. The query record query is accessed via the
HierarchuQuery.
Modifier and Type | Method and Description |
---|---|
HierarchySearchResults |
getHierarchiesBySearch(HierarchyQuery hierarchyQuery,
HierarchySearch hierarchySearch)
Gets the search results matching the given search query using the
given search.
|
HierarchyQuery |
getHierarchyQueryFromInspector(HierarchyQueryInspector hierarchyQueryInspector)
Gets a hierarchy query from an inspector.
|
HierarchySearch |
getHierarchySearch()
Gets a hierarchy search.
|
HierarchySearchOrder |
getHierarchySearchOrder()
Gets a hierarchy search order.
|
canSearchHierarchies, getHierarchiesByQuery, getHierarchyQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
HierarchySearch getHierarchySearch()
mandatory
- This method must be implemented. HierarchySearchOrder getHierarchySearchOrder()
HierarchySearchOrder
is supplied to a HierarchySearch
to specify the
ordering of results.mandatory
- This method must be implemented. HierarchySearchResults getHierarchiesBySearch(HierarchyQuery hierarchyQuery, HierarchySearch hierarchySearch) throws OperationFailedException, PermissionDeniedException
hierarchyQuery
- the hierarchy queryhierarchySearch
- the hierarchy searchNullArgumentException
- hierarchyQuery
or hierarchySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- hierarchyQuery
or
hierarchySearch
is not of this servicemandatory
- This method must be implemented. HierarchyQuery getHierarchyQueryFromInspector(HierarchyQueryInspector hierarchyQueryInspector)
HierarchySearchResults.
hierarchyQueryInspector
- a hierarchy query inspectorNullArgumentException
- hierarchyQueryInspector
is null
UnsupportedException
- hierarchyQueryInspector
is not of this servicemandatory
- This method must be implemented.