org.osid.course.plan

Interface PlanSearchOrder

All Superinterfaces:

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

public interface PlanSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
CourseOfferingSearchOrder	getCourseOfferingSearchOrder() Gets the course offering order.
PlanSearchOrderRecord	getPlanSearchOrderRecord(Type planRecordType) Gets the plan search order record corresponding to the given plan record Type.
SyllabusSearchOrder	getSyllabusSearchOrder() Gets the syllabus order.
void	orderByCourseOffering(SearchOrderStyle style) Specifies a preference for ordering the result set by the course offering.
void	orderBySyllabus(SearchOrderStyle style) Specifies a preference for ordering the result set by the syllabus.
boolean	supportsCourseOfferingSearchOrder() Tests if a course offering order is available.
boolean	supportsSyllabusSearchOrder() Tests if a syllabus 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

orderBySyllabus

void orderBySyllabus(SearchOrderStyle style)

Specifies a preference for ordering the result set by the syllabus.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsSyllabusSearchOrder

boolean supportsSyllabusSearchOrder()

Tests if a syllabus order is available.

Returns:

true if a syllabus order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSyllabusSearchOrder

SyllabusSearchOrder getSyllabusSearchOrder()

Gets the syllabus order.

Returns:

the syllabus search order

Throws:

UnimplementedException - supportsSyllabusSearchOrder() is false

Compliance:

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

orderByCourseOffering

void orderByCourseOffering(SearchOrderStyle style)

Specifies a preference for ordering the result set by the course offering.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsCourseOfferingSearchOrder

boolean supportsCourseOfferingSearchOrder()

Tests if a course offering order is available.

Returns:

true if a course offering order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCourseOfferingSearchOrder

CourseOfferingSearchOrder getCourseOfferingSearchOrder()

Gets the course offering order.

Returns:

the course offering search order

Throws:

UnimplementedException - supportsCourseOfferingSearchOrder() is false

Compliance:

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

getPlanSearchOrderRecord

PlanSearchOrderRecord getPlanSearchOrderRecord(Type planRecordType)
                                               throws OperationFailedException

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

Parameters:

planRecordType - a plan record type

Returns:

the plan search order record

Throws:

NullArgumentException - planRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(planRecordType) is false

Compliance:

mandatory - This method must be implemented.