Interface | osid.recognition.ConvocationAcademySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupConvocationAcademyMappings | ||
Description |
Tests if this user can perform lookups of
convocation/academy mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known lookup methods in this session
will result in a | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeAcademyView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryAcademyView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getConvocationIdsByAcademy | ||
Description |
Gets the list of Convocation Ids associated with an
| ||
Parameters | osid.id.Id | academyId | Id of an Academy. |
Return | osid.id.IdList | list of related convocation Ids | |
Errors | NOT_FOUND | academyId is not found | |
NULL_ARGUMENT | academyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConvocationsByAcademy | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | academyId | Id of an Academy |
Return | osid.recognition.ConvocationList | list of related convocations | |
Errors | NOT_FOUND | academyId is not found | |
NULL_ARGUMENT | academyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConvocationIdsByAcademies | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | academyIds | list of academy Ids |
Return | osid.id.IdList | list of convocation Ids | |
Errors | NULL_ARGUMENT | academyIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConvocationsByAcademies | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | academyIds | list of academy Ids |
Return | osid.recognition.ConvocationList | list of convocations | |
Errors | NULL_ARGUMENT | academyIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAcademyIdsByConvocation | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | convocationId | Id of a Convocation |
Return | osid.id.IdList | list of academy Ids | |
Errors | NOT_FOUND | convocationId is not found | |
NULL_ARGUMENT | convocationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAcademiesByConvocation | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | convocationId | Id of a Convocation |
Return | osid.recognition.AcademyList | list of academies | |
Errors | NOT_FOUND | convocationId is not found | |
NULL_ARGUMENT | convocationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |