Interface | osid.recognition.ConferralQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching Conferrals may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
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 | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchConferrals | ||
Description |
Tests if this user can perform susbcription searches. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known all methods in this session will result in a | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedAcademyView | ||
Description |
Federates the view for methods in this session. A federated view will include conferrals in academies which are children of this academy in the academy hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedAcademyView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this academy only. | ||
Compliance | mandatory | This method is 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 | getConferralsByQuery | ||
Description |
Gets a list of conferrals matching the given conferral query. | ||
Parameters | osid.recognition.ConferralQuery | conferralQuery | the conferral query |
Return | osid.recognition.ConferralList | the returned ConferralList | |
Errors | NULL_ARGUMENT | conferralQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | conferralQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |