public interface CourseOfferingSearch extends OsidSearch
The search interface for governing course offering searches.
Modifier and Type | Method and Description |
---|---|
CourseOfferingSearchRecord |
getCourseOfferingSearchRecord(Type courseOfferingSearchRecordType)
Gets the course offering search record corresponding to the given
course offering search record
Type. |
void |
orderCourseOfferingResults(CourseOfferingSearchOrder courseOfferingSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongCourseOfferings(IdList courseOfferingIds)
Execute this search among the given list of course offerings.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongCourseOfferings(IdList courseOfferingIds)
courseOfferingIds
- list of coursesNullArgumentException
- courseOfferingIds
is null
mandatory
- This method must be implemented. void orderCourseOfferingResults(CourseOfferingSearchOrder courseOfferingSearchOrder)
courseOfferingSearchOrder
- course search orderNullArgumentException
-
courseOfferingSearchOrder
is null
UnsupportedException
- courseOfferingSearchOrder
is not of this servicemandatory
- This method must be implemented. CourseOfferingSearchRecord getCourseOfferingSearchRecord(Type courseOfferingSearchRecordType) throws OperationFailedException
Type.
This method is used
to retrieve an object implementing the requested record.courseOfferingSearchRecordType
- a course search record typeNullArgumentException
-
courseOfferingSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(courseOfferingSearchRecordType)
is
false
mandatory
- This method must be implemented.