Interface | osid.recognition.AwardSmartAcademySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. An This | ||
Method | getAcademyId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Academy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getAcademy | ||
Description |
Gets the | ||
Return | osid.recognition.Academy | the Academy associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartAcademies | ||
Description |
Tests if this user can manage smart academies. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known methods in this
session will result in a | ||
Return | boolean | false if smart academy management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAwardQuery | ||
Description |
Gets an award query. | ||
Return | osid.recognition.AwardQuery | the award query | |
Compliance | mandatory | This method must be implemented. | |
Method | getAwardSearchOrder | ||
Description |
Gets an award search order. | ||
Return | osid.recognition.AwardSearchOrder | the award search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyAwardQuery | ||
Description |
Applies an award query to this academy. | ||
Parameters | osid.recognition.AwardQuery | awardQuery | the award query |
Errors | NULL_ARGUMENT | awardQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | awardQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectAwardQuery | ||
Description |
Gets an award query inspector for this academy. | ||
Return | osid.recognition.AwardQueryInspector | the award query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyAwardSequencing | ||
Description |
Applies an award search order to this academy. | ||
Parameters | osid.recognition.AwardSearchOrder | awardSearchOrder | the award search order |
Errors | NULL_ARGUMENT | awardSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | awardSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardQueryFromInspector | ||
Description |
Gets an award query from an inspector. | ||
Parameters | osid.recognition.AwardQueryInspector | awardQueryInspector | a query inspector |
Return | osid.recognition.AwardQuery | the award query | |
Errors | NULL_ARGUMENT | awardQueryInspector is null | |
UNSUPPORTED | awardQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |