Interface | osid.recognition.ConvocationSearchSession | ||
---|---|---|---|
Implements | osid.recognition.ConvocationQuerySession | ||
Description |
This session provides methods for searching Convocations may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getConvocationSearch | ||
Description |
Gets a convocation search. | ||
Return | osid.recognition.ConvocationSearch | the convocation search | |
Compliance | mandatory | This method must be implemented. | |
Method | getConvocationSearchOrder | ||
Description |
Gets a convocation search order. The | ||
Return | osid.recognition.ConvocationSearchOrder | the convocation search order interface | |
Compliance | mandatory | This method must be implemented. | |
Method | getConvocationsBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.recognition.ConvocationQuery | convocationQuery | the convocation query |
osid.recognition.ConvocationSearch | convocationSearch | the convocation search | |
Return | osid.recognition.ConvocationSearchResults | the convocation search results | |
Errors | NULL_ARGUMENT | convocationQuery or convocationSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | convocationQuery or convocationSearch is not
of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConvocationQueryFromInspector | ||
Description |
Gets a convocation query from an inspector. The
inspector is available from an | ||
Parameters | osid.recognition.ConvocationQueryInspector | convocationQueryInspector | a convocation query inspector |
Return | osid.recognition.ConvocationQuery | the convocation query | |
Errors | NULL_ARGUMENT | convocationQueryInspector is null | |
UNSUPPORTED | convocationQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |