Interface JournalEntrySearchSession

All Superinterfaces:

AutoCloseable, Closeable, JournalEntryQuerySession, OsidSession, OsidSession

public interface JournalEntrySearchSession
extends JournalEntryQuerySession

This session provides methods for searching JournalEntries . The search query is constructed using the JournalEntryQuery . The journal record Type also specifies the record for the journal query.

getJournalEntriesByQuery() is the basic search method and returns a list of Journal elements. A more advanced search may be performed with getJournalEntriesBySearch() . It accepts a JournalEntrySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getJournalEntriesBySearch() returns a JournalEntrySearchResults that can be used to access the resulting JournalEntryList or be used to perform a search within the result set through JournalEntrySearch .

Journal entries may have a query record indicated by their respective record types. The query record is accessed via the JournalEntryQuery . The returns in this session may not be cast directly to these interfaces.

Method Summary

Modifier and Type	Method	Description
JournalEntrySearchResults	getJournalEntriesBySearch(JournalEntryQuery journalEntryQuery, JournalEntrySearch journalEntrySearch)	Gets the search results matching the given search.
JournalEntryQuery	getJournalEntryQueryFromInspector(JournalEntryQueryInspector journalEntryQueryInspector)	Gets a journal entry query from an inspector.
JournalEntrySearch	getJournalEntrySearch()	Gets a journal entry search.
JournalEntrySearchOrder	getJournalEntrySearchOrder()	Gets a journal entry search order.

Methods inherited from interface Closeable

close

Methods inherited from interface JournalEntryQuerySession

canSearchJournalEntries, getJournal, getJournalEntriesByQuery, getJournalEntryQuery, getJournalId, useFederatedJournalView, useIsolatedJournalView

Modifier and Type	Method	Description
boolean	canSearchJournalEntries()	Tests if this user can perform Journal searches.
Journal	getJournal()	Gets the Journal associated with this session.
JournalEntryList	getJournalEntriesByQuery(JournalEntryQuery journalEntryQuery)	Gets a list of journal entries matching the given journal entry query.
JournalEntryQuery	getJournalEntryQuery()	Gets a journal entry query.
Id	getJournalId()	Gets the Journal Id associated with this session.
void	useFederatedJournalView()	Federates the view for methods in this session.
void	useIsolatedJournalView()	Isolates the view for methods in this session.

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getJournalEntrySearch

JournalEntrySearch getJournalEntrySearch()

Gets a journal entry search.

Returns:

the journal entry search

Compliance:

mandatory - This method must be implemented.

getJournalEntrySearchOrder

JournalEntrySearchOrder getJournalEntrySearchOrder()

Gets a journal entry search order. The JournalEntrySearchOrder is supplied to a JournalEntrySearch to specify the ordering of results.

Returns:

the journal entry search order

Compliance:

mandatory - This method must be implemented.

getJournalEntriesBySearch

JournalEntrySearchResults getJournalEntriesBySearch(JournalEntryQuery journalEntryQuery,
 JournalEntrySearch journalEntrySearch)
                                             throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

journalEntryQuery - the journal entry query

journalEntrySearch - the journal entry search

Returns:

the search results

Throws:

NullArgumentException - journalEntryQuery or journalEntrySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - journalEntryQuery or journalEntrySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getJournalEntryQueryFromInspector

JournalEntryQuery getJournalEntryQueryFromInspector(JournalEntryQueryInspector journalEntryQueryInspector)

Gets a journal entry query from an inspector. The inspector is available from a JournalEntrySearchResults .

Parameters:

journalEntryQueryInspector - a journal entry query inspector

Returns:

the journal entry query

Throws:

NullArgumentException - journalEntryQueryInspector is null

UnsupportedException - journalEntryQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.