public interface ActivitySearchOrder extends OsidRelationshipSearchOrder, OsidSubjugateableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ActivitySearchOrderRecord |
getActivitySearchOrderRecord(Type activityRecordType)
Gets the activity search order record corresponding to the given
activity record
Type. |
CourseSearchOrder |
getActivityUnitSearchOrder()
Gets the activity unit search order.
|
CourseOfferingSearchOrder |
getCourseOfferingSearchOrder()
Gets the course offering search order.
|
TermSearchOrder |
getTermSearchOrder()
Gets the term order.
|
void |
orderByActivityUnit(SearchOrderStyle style)
Specifies a preference for ordering the result set by activity unit.
|
void |
orderByCourseOffering(SearchOrderStyle style)
Specifies a preference for ordering the result set by course offering.
|
void |
orderByImplicit(SearchOrderStyle style)
Specifies a preference for ordering the result set by the implicit
status.
|
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 |
orderByRecurringWeekly(SearchOrderStyle style)
Specifies a preference for ordering the result set by weekly
recurring.
|
void |
orderByTerm(SearchOrderStyle style)
Specifies a preference for ordering the result set by term.
|
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 |
supportsActivityUnitSearchOrder()
Tests if an activity unit search order is available.
|
boolean |
supportsCourseOfferingSearchOrder()
Tests if a course offering search is available.
|
boolean |
supportsTermSearchOrder()
Tests if a term search order is available.
|
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByActivityUnit(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsActivityUnitSearchOrder()
true
if an activity unit search order is
available, false
otherwisemandatory
- This method must be implemented. CourseSearchOrder getActivityUnitSearchOrder()
UnimplementedException
-
supportsActivityUnitSearchOrder()
is false
optional
- This method must be implemented if
supportsActivityUnitSearchOrder()
is true.
void orderByCourseOffering(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsCourseOfferingSearchOrder()
true
if a course offering search order is
available, false
otherwisemandatory
- This method must be implemented. CourseOfferingSearchOrder getCourseOfferingSearchOrder()
UnimplementedException
-
supportsCourseOfferingSearchOrder()
is false
optional
- This method must be implemented if
supportsActivityUnitSearchOrder()
is true.
void orderByTerm(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsTermSearchOrder()
true
if a term search order is available,
false
otherwisemandatory
- This method must be implemented. TermSearchOrder getTermSearchOrder()
UnimplementedException
-
supportsTermSearchOrder()
is false
optional
- This method must be implemented if
supportsTermSearchOrder()
is true.
void orderByImplicit(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByMinimumSeats(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByMaximumSeats(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByTotalTargetEffort(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByTotalTargetContactTime(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByTotalTargetIndividualEffort(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByRecurringWeekly(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByWeeklyEffort(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByWeeklyContactTime(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByWeeklyIndividualEffort(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. ActivitySearchOrderRecord getActivitySearchOrderRecord(Type activityRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.activityRecordType
- an activity record typeNullArgumentException
- activityRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(activityRecordType)
is false
mandatory
- This method must be implemented.