public interface CourseCatalogSearch extends OsidSearch
The search interface for governing course catalog searches.
Modifier and Type | Method and Description |
---|---|
CourseCatalogSearchRecord |
getCourseCatalogSearchRecord(Type courseCatalogSearchRecordType)
Gets the course catalog search record corresponding to the given
course catalog search record
Type. |
void |
orderCourseCatalogResults(CourseCatalogSearchOrder courseCatalogSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongCourseCatalogs(IdList courseCatalogIds)
Execute this search among the given list of course catalogs.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongCourseCatalogs(IdList courseCatalogIds)
courseCatalogIds
- list of course catalogsNullArgumentException
- courseCatalogIds
is null
mandatory
- This method must be implemented. void orderCourseCatalogResults(CourseCatalogSearchOrder courseCatalogSearchOrder)
courseCatalogSearchOrder
- course catalog search orderNullArgumentException
- courseCatalogSearchOrder
is null
UnsupportedException
- courseCatalogSearchOrder
is not of this servicemandatory
- This method must be implemented. CourseCatalogSearchRecord getCourseCatalogSearchRecord(Type courseCatalogSearchRecordType) throws OperationFailedException
Type.
This method is used
to retrieve an object implementing the requested record.courseCatalogSearchRecordType
- a course catalog search record
typeNullArgumentException
-
courseCatalogSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(courseCatalogSearchRecordType)
is
false
mandatory
- This method must be implemented.