Interface JournalEntrySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface JournalEntrySearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
JournalEntryList	getJournalEntries()	Gets the journal entry list resulting from a search.
JournalEntryQueryInspector	getJournalEntryQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
JournalEntrySearchResultsRecord	getJournalEntrySearchResultsRecord(Type journalEntrySearchRecordType)	Gets the journal entry search results record corresponding to the given journal entry search record Type .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getJournalEntries

JournalEntryList getJournalEntries()

Gets the journal entry list resulting from a search.

Returns:

the journal entry list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getJournalEntryQueryInspector

JournalEntryQueryInspector getJournalEntryQueryInspector()

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

Returns:

the journal entry query inspector

Compliance:

mandatory - This method must be implemented.

getJournalEntrySearchResultsRecord

JournalEntrySearchResultsRecord getJournalEntrySearchResultsRecord(Type journalEntrySearchRecordType)
                                                            throws OperationFailedException

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

Throws:

NullArgumentException - journalEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(journalEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.