public interface PositionSearchSession extends PositionQuerySession
This session provides methods for searching Position
objects. The search query is constructed using the PositionQuery.
The position record Type
also specifies the record
for the position query.
getPositionsByQuery()
is the basic search method and
returns a list of Position
elements. A more advanced search
may be performed with getPositionsBySearch().
It accepts a
PositionSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getPositionsBySearch()
returns a
PositionSearchResults
that can be used to access the resulting
PositionList
or be used to perform a search within the
result set through PositionSearch.
This session defines views that offer differing behaviors for searching.
Positions may have a query record indicated by their respective record
types. The query record is accessed via the PositionQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
PositionQuery |
getPositionQueryFromInspector(PositionQueryInspector positionQueryInspector)
Gets a position query from an inspector.
|
PositionSearchResults |
getPositionsBySearch(PositionQuery positionQuery,
PositionSearch positionSearch)
Gets the search results matching the given search.
|
PositionSearch |
getPositionSearch()
Gets a position search.
|
PositionSearchOrder |
getPositionSearchOrder()
Gets a position search order.
|
canSearchPositions, getPositionQuery, getPositionsByQuery, getRealm, getRealmId, useFederatedRealmView, useIsolatedRealmView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
PositionSearch getPositionSearch()
mandatory
- This method must be implemented. PositionSearchOrder getPositionSearchOrder()
PositionSearchOrder
is supplied to a PositionSearch
to specify the ordering
of results.mandatory
- This method must be implemented. PositionSearchResults getPositionsBySearch(PositionQuery positionQuery, PositionSearch positionSearch) throws OperationFailedException, PermissionDeniedException
positionQuery
- the position querypositionSearch
- the position searchNullArgumentException
- positionQuery
or
positionSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- positionQuery
or
positionSearch
is not of this servicemandatory
- This method must be implemented. PositionQuery getPositionQueryFromInspector(PositionQueryInspector positionQueryInspector)
PositionSearchResults.
positionQueryInspector
- a position query inspectorNullArgumentException
- positionQueryInspector
is null
UnsupportedException
- positionQueryInspector
is not of this servicemandatory
- This method must be implemented.