org.osid.journaling

Interface JournalSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface JournalSearch
extends OsidSearch

The search interface for governing journal searches.

Method Summary

Methods

Modifier and Type	Method and Description
JournalSearchRecord	getJournalSearchRecord(Type journalSearchRecordType) Gets the journal search record corresponding to the given journal search record Type.
void	orderJournalResults(JournalSearchOrder journalSearchOrder) Specify an ordering to the search results.
void	searchAmongJournals(IdList journalIds) Execute this search among the given list of journals.

Methods inherited from interface org.osid.OsidSearch

limitResultSet

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

searchAmongJournals

void searchAmongJournals(IdList journalIds)

Execute this search among the given list of journals.

Parameters:

journalIds - list of journals

Throws:

NullArgumentException - journalIds is null

Compliance:

mandatory - This method must be implemented.

orderJournalResults

void orderJournalResults(JournalSearchOrder journalSearchOrder)

Specify an ordering to the search results.

Parameters:

journalSearchOrder - journal search order

Throws:

NullArgumentException - journalSearchOrder is null

UnsupportedException - journalSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getJournalSearchRecord

JournalSearchRecord getJournalSearchRecord(Type journalSearchRecordType)
                                           throws OperationFailedException

Gets the journal search 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 record

Throws:

NullArgumentException - journalSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(journalSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.