org.osid.journaling

Interface JournalSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, JournalQuerySession, OsidSession

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.journaling.JournalQuerySession

canSearchJournals, getJournalQuery, getJournalsByQuery

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getJournalSearch

JournalSearch getJournalSearch()

Gets a journal search.

Returns:

the journal search

Compliance:

mandatory - This method must be implemented.

getJournalSearchOrder

JournalSearchOrder getJournalSearchOrder()

Gets a journal search order. The JournalSearchOrder is supplied to a JournalSearch to specify the ordering of results.

Returns:

the journal search order

Compliance:

mandatory - This method must be implemented.

getJournalsBySearch

JournalSearchResults getJournalsBySearch(JournalQuery journalQuery,
                                       JournalSearch journalSearch)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Gets the search results matching the given search.

Parameters:

journalQuery - the journal query

journalSearch - the journal search

Returns:

the journal search results

Throws:

NullArgumentException - journalQuery or journalSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - journalQuery or journalSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getJournalQueryFromInspector

JournalQuery getJournalQueryFromInspector(JournalQueryInspector journalQueryInspector)

Gets a journal query from an inspector. The inspector is available from a JournalSearchResults.

Parameters:

journalQueryInspector - a journal query inspector

Returns:

the journal query

Throws:

NullArgumentException - journalQueryInspector is null

UnsupportedException - journalQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.