public interface WorkSearchSession extends WorkQuerySession
This session provides methods for searching among Work
objects. The search query is constructed using the WorkQuery.
getWorksByQuery()
is the basic search method and
returns a list of Works.
A more advanced search may be
performed with getWorksBySearch().
It accepts a
WorkSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getWorksBySearch()
returns a WorkSearchResults
that
can be used to access the resulting WorkList
or be used to
perform a search within the result set through WorkSearch.
This session defines views that offer differing behaviors for searching.
Works may have a query record indicated by their respective record
types. The query record is accessed via the WorkQuery.
Modifier and Type | Method and Description |
---|---|
WorkQuery |
getWorkQueryFromInspector(WorkQueryInspector workQueryInspector)
Gets a work query from an inspector.
|
WorkSearchResults |
getWorksBySearch(WorkQuery workQuery,
WorkSearch workSearch)
Gets the search results matching the given search query using the
given search.
|
WorkSearch |
getWorkSearch()
Gets a work search.
|
WorkSearchOrder |
getWorkSearchOrder()
Gets a work search order.
|
canSearchWorks, getOffice, getOfficeId, getWorkQuery, getWorksByQuery, useFederatedOfficeView, useIsolatedOfficeView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
WorkSearch getWorkSearch()
mandatory
- This method must be implemented. WorkSearchOrder getWorkSearchOrder()
WorkSearchOrder
is
supplied to a WorkSearch
to specify the ordering of
results.mandatory
- This method must be implemented. WorkSearchResults getWorksBySearch(WorkQuery workQuery, WorkSearch workSearch) throws OperationFailedException, PermissionDeniedException
workQuery
- the work queryworkSearch
- the work searchNullArgumentException
- workQuery
or
workSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- workQuery
or
workSearch
is not of this servicemandatory
- This method must be implemented. WorkQuery getWorkQueryFromInspector(WorkQueryInspector workQueryInspector)
WorkSearchResults.
workQueryInspector
- a work query inspectorNullArgumentException
- workQueryInspector
is null
UnsupportedException
- workQueryInspector
is not of this servicemandatory
- This method must be implemented.