org.osid.journaling

Interface JournalSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface JournalSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Methods

Modifier and Type	Method and Description
JournalQueryInspector	getJournalQueryInspector() Gets the inspector for the query to examine the terms used in the search.
JournalList	getJournals() Gets the journal list resulting from a search.
JournalSearchResultsRecord	getJournalSearchResultsRecord(Type journalSearchRecordType) Gets the journal search results record corresponding to the given journal search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getJournals

JournalList getJournals()

Gets the journal list resulting from a search.

Returns:

the journal list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getJournalQueryInspector

JournalQueryInspector getJournalQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the journal query inspector

Compliance:

mandatory - This method must be implemented.

getJournalSearchResultsRecord

JournalSearchResultsRecord getJournalSearchResultsRecord(Type journalSearchRecordType)
                                                         throws OperationFailedException

Gets the journal search results record corresponding to the given journal search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

journalSearchRecordType - a journal search record type

Returns:

the journal search results record

Throws:

NullArgumentException - JournalSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(journalSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.