org.osid.course.program

Interface ProgramOfferingSearchOrder

All Superinterfaces:

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

public interface ProgramOfferingSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ProgramOfferingSearchOrderRecord	getProgramOfferingSearchOrderRecord(Type programOfferingRecordType) Gets the program offering search order record corresponding to the given program offering record Type.
ProgramSearchOrder	getProgramSearchOrder() Gets the course order.
TermSearchOrder	getTermSearchOrder() Gets the term order.
void	orderByCompletionRequirementsInfo(SearchOrderStyle style) Specifies a preference for ordering the result set by program completion requirements.
void	orderByMaximumSeats(SearchOrderStyle style) Specifies a preference for ordering the result set by the maximum seats.
void	orderByMinimumSeats(SearchOrderStyle style) Specifies a preference for ordering the result set by the minimum seats.
void	orderByNumber(SearchOrderStyle style) Specifies a preference for ordering the result set by program offering number.
void	orderByProgram(SearchOrderStyle style) Specifies a preference for ordering the result set by program.
void	orderByRequiresRegistration(SearchOrderStyle style) Specifies a preference for ordering the result set by program offerings requiring registration.
void	orderByTerm(SearchOrderStyle style) Specifies a preference for ordering the result set by term.
void	orderByTitle(SearchOrderStyle style) Specifies a preference for ordering the result set by program offering title.
void	orderByURL(SearchOrderStyle style) Specifies a preference for ordering the result set by url.
boolean	supportsProgramSearchOrder() Tests if a course order is available.
boolean	supportsTermSearchOrder() Tests if a term order is available.

Methods inherited from interface org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

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.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByProgram

void orderByProgram(SearchOrderStyle style)

Specifies a preference for ordering the result set by program.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsProgramSearchOrder

boolean supportsProgramSearchOrder()

Tests if a course order is available.

Returns:

true if a course order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProgramSearchOrder

ProgramSearchOrder getProgramSearchOrder()

Gets the course order.

Returns:

the program search order

Throws:

UnimplementedException - supportsProgramSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsProgramSearchOrder() is true.

orderByTerm

void orderByTerm(SearchOrderStyle style)

Specifies a preference for ordering the result set by term.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsTermSearchOrder

boolean supportsTermSearchOrder()

Tests if a term order is available.

Returns:

true if a term order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTermSearchOrder

TermSearchOrder getTermSearchOrder()

Gets the term order.

Returns:

the term search order

Throws:

UnimplementedException - supportsTermSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsTermSearchOrder() is true.

orderByTitle

void orderByTitle(SearchOrderStyle style)

Specifies a preference for ordering the result set by program offering 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 offering 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.

orderByRequiresRegistration

void orderByRequiresRegistration(SearchOrderStyle style)

Specifies a preference for ordering the result set by program offerings requiring registration.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByMinimumSeats

void orderByMinimumSeats(SearchOrderStyle style)

Specifies a preference for ordering the result set by the minimum seats.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByMaximumSeats

void orderByMaximumSeats(SearchOrderStyle style)

Specifies a preference for ordering the result set by the maximum seats.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByURL

void orderByURL(SearchOrderStyle style)

Specifies a preference for ordering the result set by url.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getProgramOfferingSearchOrderRecord

ProgramOfferingSearchOrderRecord getProgramOfferingSearchOrderRecord(Type programOfferingRecordType)
                                                                     throws OperationFailedException

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

Parameters:

programOfferingRecordType - a program offering record type

Returns:

the program offering search order record

Throws:

NullArgumentException - programOfferingRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(programOfferingRecordType) is false

Compliance:

mandatory - This method must be implemented.