OSID Logo
OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.ActivitySearchOrder
Implementsosid.OsidRelationshipSearchOrder
osid.OsidSubjugateableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByActivityUnit
Description

Specifies a preference for ordering the result set by activity unit.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsActivityUnitSearchOrder
Description

Tests if an activity unit search order is available.

Returnboolean true if an activity unit search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetActivityUnitSearchOrder
Description

Gets the activity unit search order.

Returnosid.course.CourseSearchOrderthe activity unit search order
ErrorsUNIMPLEMENTED supportsActivityUnitSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsActivityUnitSearchOrder() is true.
MethodorderByCourseOffering
Description

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

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsCourseOfferingSearchOrder
Description

Tests if a course offering search is available.

Returnboolean true if a course offering search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCourseOfferingSearchOrder
Description

Gets the course offering search order.

Returnosid.course.CourseOfferingSearchOrderthe course offering search order
ErrorsUNIMPLEMENTED supportsCourseOfferingSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsActivityUnitSearchOrder() is true.
MethodorderByTerm
Description

Specifies a preference for ordering the result set by term.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsTermSearchOrder
Description

Tests if a term search order is available.

Returnboolean true if a term search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetTermSearchOrder
Description

Gets the term order.

Returnosid.course.TermSearchOrderthe term search order
ErrorsUNIMPLEMENTED supportsTermSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsTermSearchOrder() is true.
MethodorderByImplicit
Description

Specifies a preference for ordering the result set by the implicit status.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByMinimumSeats
Description

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

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByMaximumSeats
Description

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

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByTotalTargetEffort
Description

Specifies a preference for ordering the result set by the total effort.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByTotalTargetContactTime
Description

Specifies a preference for ordering the result set by the total contact.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByTotalTargetIndividualEffort
Description

Specifies a preference for ordering the result set by total individual effort.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByRecurringWeekly
Description

Specifies a preference for ordering the result set by weekly recurring.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByWeeklyEffort
Description

Specifies a preference for ordering the result set by the weekly effort.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByWeeklyContactTime
Description

Specifies a preference for ordering the result set by the weekly contact.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByWeeklyIndividualEffort
Description

Specifies a preference for ordering the result set by weekly individual effort.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetActivitySearchOrderRecord
Description

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

Parametersosid.type.TypeactivityRecordTypean activity record type
Returnosid.course.records.ActivitySearchOrderRecordthe activity search order record
ErrorsNULL_ARGUMENT activityRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(activityRecordType) is false
CompliancemandatoryThis method must be implemented.