Interface JournalEntrySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface JournalEntrySearch
extends OsidSearch

The search interface for governing journal entry searches.

Method Summary

Modifier and Type	Method	Description
JournalEntrySearchRecord	getJournalEntrySearchRecord(Type journalEntrySearchRecordType)	Gets the journal entry search record corresponding to the given journal entry search record Type .This method is used to retrieve an object implementing the requested record.
void	orderJournalEntryResults(JournalEntrySearchOrder journalEntrySearchOrder)	Specify an ordering to the search results.
void	searchAmongJournalEntries(IdList journalEntryIds)	Execute this search among the given list of journal entries.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongJournalEntries

void searchAmongJournalEntries(IdList journalEntryIds)

Execute this search among the given list of journal entries.

Parameters:

journalEntryIds - list of journal entries

Throws:

NullArgumentException - journalEntryIds is null

Compliance:

mandatory - This method must be implemented.

orderJournalEntryResults

void orderJournalEntryResults(JournalEntrySearchOrder journalEntrySearchOrder)

Specify an ordering to the search results.

Parameters:

journalEntrySearchOrder - journal entry search order

Throws:

NullArgumentException - journalEntrySearchOrder is null

UnsupportedException - journalEntrySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getJournalEntrySearchRecord

JournalEntrySearchRecord getJournalEntrySearchRecord(Type journalEntrySearchRecordType)
                                              throws OperationFailedException

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

Parameters:

journalEntrySearchRecordType - a journal entry search record type

Returns:

the journal entry search record

Throws:

NullArgumentException - journalEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(journalEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.