OSID Logo
OSID Specifications
journaling package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.JournalSearchOrder
Implementsosid.OsidCatalogSearchOrder
Description

An interface for specifying the ordering of search results.

MethodgetJournalSearchOrderRecord
Description

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

Parametersosid.type.TypejournalRecordTypea journal record type
Returnosid.journaling.records.JournalSearchOrderRecordthe journal search order record
ErrorsNULL_ARGUMENT journalRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(journalRecordType) is false
CompliancemandatoryThis method must be implemented.