Interface | osid.recognition.ConferralSmartAcademySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A 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 | getConferralQuery | ||
Description |
Gets a conferral query. | ||
Return | osid.recognition.ConferralQuery | the conferral query | |
Compliance | mandatory | This method must be implemented. | |
Method | getConferralSearchOrder | ||
Description |
Gets a conferral search order. | ||
Return | osid.recognition.ConferralSearchOrder | the conferral search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyConferralQuery | ||
Description |
Applies a conferral query to this academy. | ||
Parameters | osid.recognition.ConferralQuery | conferralQuery | the conferral query |
Errors | NULL_ARGUMENT | conferralQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | conferralQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectConferralQuery | ||
Description |
Gets a conferral query inspector for this academy. | ||
Return | osid.recognition.ConferralQueryInspector | the conferral query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyConferralSequencing | ||
Description |
Applies a conferral search order to this academy. | ||
Parameters | osid.recognition.ConferralSearchOrder | conferralSearchOrder | the conferral search order |
Errors | NULL_ARGUMENT | conferralSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | conferralSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConferralQueryFromInspector | ||
Description |
Gets a conferral query from an inspector. | ||
Parameters | osid.recognition.ConferralQueryInspector | conferralQueryInspector | a query inspector |
Return | osid.recognition.ConferralQuery | the conferral query | |
Errors | NULL_ARGUMENT | conferralQueryInspector is null | |
UNSUPPORTED | conferralQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |