org.osid.journaling

Interface JournalSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidCatalogSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface JournalSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
JournalSearchOrderRecord	getJournalSearchOrderRecord(Type journalRecordType) Gets the journal search order record corresponding to the given journal record Type.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getJournalSearchOrderRecord

JournalSearchOrderRecord getJournalSearchOrderRecord(Type journalRecordType)
                                                     throws OperationFailedException

Gets the journal search order record corresponding to the given journal record Type. Multiple retrievals return the same underlying object.

Parameters:

journalRecordType - a journal record type

Returns:

the journal search order record

Throws:

NullArgumentException - journalRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(journalRecordType) is false

Compliance:

mandatory - This method must be implemented.