Interface | osid.room.CampusLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
Method | canLookupCampuses | ||
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 | useComparativeCampusView | ||
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 | usePlenaryCampusView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | Id of the Campus |
Return | osid.room.Campus | the campus | |
Errors | NOT_FOUND | campusId not found | |
NULL_ARGUMENT | campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getCampusesByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | campusIds | the list of Ids to retrieve |
Return | osid.room.CampusList | the returned Campus list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | campusIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCampusesByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | campusGenusType | a campus genus type |
Return | osid.room.CampusList | the returned Campus list | |
Errors | NULL_ARGUMENT | campusGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCampusesByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | campusGenusType | a campus genus type |
Return | osid.room.CampusList | the returned Campus list | |
Errors | NULL_ARGUMENT | campusGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCampusesByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | campusRecordType | a campus record type |
Return | osid.room.CampusList | the returned Campus list | |
Errors | NULL_ARGUMENT | campusRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCampusesByProvider | ||
Description |
Gets a | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.room.CampusList | the returned Campus 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 | getCampuses | ||
Description |
Gets all | ||
Return | osid.room.CampusList | a list of Campuses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |