public interface OublietteSearchSession extends OublietteQuerySession
This session provides methods for searching among Oubliette
objects. The search query is constructed using the
OublietteQuery.
getOublietteByQuery()
is the basic search method and
returns a list of Oubliettes.
A more advanced search may be
performed with getOublietteBySearch().
It accepts a
OublietteSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getOublietteBySearch()
returns a
OublietteSearchResults
that can be used to access the resulting
OublietteList
or be used to perform a search within the
result set through OublietteSearch.
Oubliettes may have a query record indicated by their respective
record types. The query record is accessed via the OublietteQuery.
Modifier and Type | Method and Description |
---|---|
OublietteSearchResults |
getOublietteBySearch(OublietteQuery oublietteQuery,
OublietteSearch oublietteSearch)
Gets the search results matching the given search query using the
given search.
|
OublietteQuery |
getOublietteQueryFromInspector(OublietteQueryInspector oublietteQueryInspector)
Gets an oubliette query from an inspector.
|
OublietteSearch |
getOublietteSearch()
Gets an oubliette search.
|
OublietteSearchOrder |
getOublietteSearchOrder()
Gets an oubliette search order.
|
canSearchOubliettes, getOublietteQuery, getOubliettesByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
OublietteSearch getOublietteSearch()
mandatory
- This method must be implemented. OublietteSearchOrder getOublietteSearchOrder()
OublietteSearchOrder
is supplied to a OublietteSearch
to specify the
ordering of results.mandatory
- This method must be implemented. OublietteSearchResults getOublietteBySearch(OublietteQuery oublietteQuery, OublietteSearch oublietteSearch) throws OperationFailedException, PermissionDeniedException
oublietteQuery
- the oubliette queryoublietteSearch
- the oubliette searchNullArgumentException
- oublietteQuery
or oublietteSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- oublietteQuery
or
oublietteSearch
is not of this servicemandatory
- This method must be implemented. OublietteQuery getOublietteQueryFromInspector(OublietteQueryInspector oublietteQueryInspector)
OublietteSearchResults.
oublietteQueryInspector
- an oubliette query inspectorNullArgumentException
- oublietteQueryInspector
is null
UnsupportedException
- oublietteQueryInspector
is not of this servicemandatory
- This method must be implemented.