public interface ChecklistSearchSession extends ChecklistQuerySession
This session provides methods for searching Checklist
objects. The search query is constructed using the ChecklistQuery.
The checklist record Type
also specifies the record
for the checklist query.
getChecklistsByQuery()
is the basic search method and
returns a list of Checklist
elements. A more advanced
search may be performed with getChecklistsBySearch().
It
accepts a ChecklistSearch
in addition to the query for the
purpose of specifying additional options affecting the entire search, such
as ordering. getChecklistsBySearch()
returns a
ChecklistSearchResults
that can be used to access the resulting
ChecklistList
or be used to perform a search within the
result set through ChecklistSearch.
Checklists may have a query record indicated by their respective
record types. The query record is accessed via the ChecklistQuery.
The returns in this session may not be cast directly to these
interfaces.
Modifier and Type | Method and Description |
---|---|
ChecklistQuery |
getChecklistQueryFromInspector(ChecklistQueryInspector checklistQueryInspector)
Gets an entry query from an inspector.
|
ChecklistSearchResults |
getChecklistsBySearch(ChecklistQuery checklistQuery,
ChecklistSearch checklistSearch)
Gets the search results matching the given search.
|
ChecklistSearch |
getChecklistSearch()
Gets a checklist search.
|
ChecklistSearchOrder |
getChecklistSearchOrder()
Gets a checklist search order.
|
canSearchChecklists, getChecklistQuery, getChecklistsByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ChecklistSearch getChecklistSearch()
mandatory
- This method must be implemented. ChecklistSearchOrder getChecklistSearchOrder()
ChecklistSearchOrder
is supplied to a ChecklistSearch
to specify the
ordering of results.mandatory
- This method must be implemented. ChecklistSearchResults getChecklistsBySearch(ChecklistQuery checklistQuery, ChecklistSearch checklistSearch) throws OperationFailedException, PermissionDeniedException
checklistQuery
- the checklist querychecklistSearch
- the checklist searchNullArgumentException
- checklistQuery
or checklistSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- checklistQuery
or
checklistSearch
is not of this servicemandatory
- This method must be implemented. ChecklistQuery getChecklistQueryFromInspector(ChecklistQueryInspector checklistQueryInspector)
ChecklistSearchResults.
checklistQueryInspector
- a checklist query inspectorNullArgumentException
- checklistQueryInspector
is null
UnsupportedException
- checklistQueryInspector
is not of this servicemandatory
- This method must be implemented.