Interface | osid.course.plan.PlanSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getPlans | ||
Description |
Gets the plan list resulting from a search. | ||
Return | osid.course.plan.PlanList | the plan list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getPlanQueryInspector | ||
Description |
Gets the inspector for the query to examine the terns used in the search. | ||
Return | osid.course.plan.PlanQueryInspector | the plan query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getPlanSearchResultsRecord | ||
Description |
Gets the plan search results record corresponding to
the given plan search record | ||
Parameters | osid.type.Type | planSearchRecordType | a plan search record type |
Return | osid.course.plan.records.PlanSearchResultsRecord | the plan search record | |
Errors | NULL_ARGUMENT | planSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(planSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |