org.osid.inquiry

Interface AuditSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidGovernatorSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface AuditSearchOrder
extends OsidGovernatorSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AuditSearchOrderRecord	getAuditSearchOrderRecord(Type auditRecordType) Gets the audit search order record corresponding to the given audit 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.OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getAuditSearchOrderRecord

AuditSearchOrderRecord getAuditSearchOrderRecord(Type auditRecordType)
                                                 throws OperationFailedException

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

Parameters:

auditRecordType - an audit record type

Returns:

the audit search order record

Throws:

NullArgumentException - auditRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auditRecordType) is false

Compliance:

mandatory - This method must be implemented.