org.osid.course.program

Interface ProgramSearchOrder

All Superinterfaces:

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

public interface ProgramSearchOrder
extends OsidObjectSearchOrder, OsidOperableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ProgramSearchOrderRecord	getProgramSearchOrderRecord(Type programRecordType) Gets the program search order record corresponding to the given program record Type.
void	orderByCompletionRequirementsInfo(SearchOrderStyle style) Specifies a preference for ordering the result set by program completion requirements.
void	orderByNumber(SearchOrderStyle style) Specifies a preference for ordering the result set by program number.
void	orderByTitle(SearchOrderStyle style) Specifies a preference for ordering the result set by program title.

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

Method Detail

orderByTitle

void orderByTitle(SearchOrderStyle style)

Specifies a preference for ordering the result set by program title.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByNumber

void orderByNumber(SearchOrderStyle style)

Specifies a preference for ordering the result set by program number.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByCompletionRequirementsInfo

void orderByCompletionRequirementsInfo(SearchOrderStyle style)

Specifies a preference for ordering the result set by program completion requirements.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getProgramSearchOrderRecord

ProgramSearchOrderRecord getProgramSearchOrderRecord(Type programRecordType)
                                                     throws OperationFailedException

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

Parameters:

programRecordType - a program record type

Returns:

the program search order record

Throws:

NullArgumentException - programRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(programRecordType) is false

Compliance:

mandatory - This method must be implemented.