org.osid.course

Interface ActivityUnitSearchOrder

All Superinterfaces:

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

public interface ActivityUnitSearchOrder
extends OsidObjectSearchOrder, OsidOperableSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ActivityUnitSearchOrderRecord	getActivityUnitSearchOrderRecord(Type activityUnitRecordType) Gets the activity unit search order record corresponding to the given activity unit record Type.
CourseSearchOrder	getCourseSearchOrder() Gets the course order.
void	orderByCourse(SearchOrderStyle style) Specifies a preference for ordering the result set by course.
void	orderByRecurringWeekly(SearchOrderStyle style) Specifies a preference for ordering the result set by weekly recurring.
void	orderByTotalTargetContactTime(SearchOrderStyle style) Specifies a preference for ordering the result set by the total contact.
void	orderByTotalTargetEffort(SearchOrderStyle style) Specifies a preference for ordering the result set by the total effort.
void	orderByTotalTargetIndividualEffort(SearchOrderStyle style) Specifies a preference for ordering the result set by total individual effort.
void	orderByWeeklyContactTime(SearchOrderStyle style) Specifies a preference for ordering the result set by the weekly contact.
void	orderByWeeklyEffort(SearchOrderStyle style) Specifies a preference for ordering the result set by the weekly effort.
void	orderByWeeklyIndividualEffort(SearchOrderStyle style) Specifies a preference for ordering the result set by weekly individual effort.
boolean	supportsCourseSearchOrder() Tests if a course order is available.

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

orderByCourse

void orderByCourse(SearchOrderStyle style)

Specifies a preference for ordering the result set by course.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsCourseSearchOrder

boolean supportsCourseSearchOrder()

Tests if a course order is available.

Returns:

true if a course order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCourseSearchOrder

CourseSearchOrder getCourseSearchOrder()

Gets the course order.

Returns:

the course search order

Throws:

UnimplementedException - supportsCourseSearchOrder() is false

Compliance:

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

orderByTotalTargetEffort

void orderByTotalTargetEffort(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByTotalTargetContactTime

void orderByTotalTargetContactTime(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByTotalTargetIndividualEffort

void orderByTotalTargetIndividualEffort(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByRecurringWeekly

void orderByRecurringWeekly(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByWeeklyEffort

void orderByWeeklyEffort(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByWeeklyContactTime

void orderByWeeklyContactTime(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByWeeklyIndividualEffort

void orderByWeeklyIndividualEffort(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getActivityUnitSearchOrderRecord

ActivityUnitSearchOrderRecord getActivityUnitSearchOrderRecord(Type activityUnitRecordType)
                                                               throws OperationFailedException

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

Parameters:

activityUnitRecordType - an activity unit record type

Returns:

the activity unit search order record

Throws:

NullArgumentException - activityUnitRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityUnitRecordType) is false

Compliance:

mandatory - This method must be implemented.