Interface | osid.recognition.AcademyLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
Method | canLookupAcademies | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are 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 | getAcademy | ||
Description |
Gets the | ||
Parameters | osid.id.Id | jouralId | Id of the Academy |
Return | osid.recognition.Academy | the academy | |
Errors | NOT_FOUND | academyId not found | |
NULL_ARGUMENT | academyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getAcademiesByIds | ||
Description |
Gets an | ||
Parameters | osid.id.IdList | academyIds | the list of Ids to retrieve |
Return | osid.recognition.AcademyList | the returned Academy list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | academyIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAcademiesByGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | academyGenusType | an academy genus type |
Return | osid.recognition.AcademyList | the returned Academy list | |
Errors | NULL_ARGUMENT | academyGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAcademiesByParentGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | academyGenusType | an academy genus type |
Return | osid.recognition.AcademyList | the returned Academy list | |
Errors | NULL_ARGUMENT | academyGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAcademiesByRecordType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | academyRecordType | an academy record type |
Return | osid.recognition.AcademyList | the returned Academy list | |
Errors | NULL_ARGUMENT | academyRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAcademiesByProvider | ||
Description |
Gets an | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.recognition.AcademyList | the returned Academy list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAcademies | ||
Description |
Gets all | ||
Return | osid.recognition.AcademyList | a list of Academies | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |