public interface JournalSearchSession extends JournalQuerySession
This session provides methods for searching Journal
objects. The search query is constructed using the JournalQuery.
The journal record Type
also specifies the record
for the journal query.
getJournalsByQuery()
is the basic search method and
returns a list of Journal
elements. A more advanced search
may be performed with getJournalsBySearch().
It accepts a
JournalSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getJournalsBySearch()
returns a
JournalSearchResults
that can be used to access the resulting
JournalList
or be used to perform a search within the
result set through JournalSearch.
Journals may have a query record indicated by their respective record
types. The query record is accessed via the JournalQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
JournalQuery |
getJournalQueryFromInspector(JournalQueryInspector journalQueryInspector)
Gets a journal query from an inspector.
|
JournalSearchResults |
getJournalsBySearch(JournalQuery journalQuery,
JournalSearch journalSearch)
Gets the search results matching the given search.
|
JournalSearch |
getJournalSearch()
Gets a journal search.
|
JournalSearchOrder |
getJournalSearchOrder()
Gets a journal search order.
|
canSearchJournals, getJournalQuery, getJournalsByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
JournalSearch getJournalSearch()
mandatory
- This method must be implemented. JournalSearchOrder getJournalSearchOrder()
JournalSearchOrder
is
supplied to a JournalSearch
to specify the ordering of
results.mandatory
- This method must be implemented. JournalSearchResults getJournalsBySearch(JournalQuery journalQuery, JournalSearch journalSearch) throws OperationFailedException, PermissionDeniedException
journalQuery
- the journal queryjournalSearch
- the journal searchNullArgumentException
- journalQuery
or
journalSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- journalQuery
or
journalSearch
is not of this servicemandatory
- This method must be implemented. JournalQuery getJournalQueryFromInspector(JournalQueryInspector journalQueryInspector)
JournalSearchResults.
journalQueryInspector
- a journal query inspectorNullArgumentException
- journalQueryInspector
is null
UnsupportedException
- journalQueryInspector
is not of this servicemandatory
- This method must be implemented.