org.osid.course.program

Interface CredentialSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, Suppliable

public interface CredentialSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
CredentialSearchOrderRecord	getCredentialSearchOrderRecord(Type credentialRecordType) Gets the credential search order record corresponding to the given credential record Type.
void	orderByLifetime(SearchOrderStyle style) Specifies a preference for ordering the result set by lifetime.

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

Method Detail

orderByLifetime

void orderByLifetime(SearchOrderStyle style)

Specifies a preference for ordering the result set by lifetime.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getCredentialSearchOrderRecord

CredentialSearchOrderRecord getCredentialSearchOrderRecord(Type credentialRecordType)
                                                           throws OperationFailedException

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

Parameters:

credentialRecordType - a credential record type

Returns:

the credential search order record

Throws:

NullArgumentException - credentialRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(credentialRecordType) is false

Compliance:

mandatory - This method must be implemented.