OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.CampusLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving Campus objects. The Campus represents a collection of disptches and rooms.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
MethodcanLookupCampuses
Description

Tests if this user can perform Campus lookups. 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 PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeCampusView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryCampusView
Description

A complete view of the Campus returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetCampus
Description

Gets the Campus specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Campus may have a different Id than requested, such as the case where a duplicate Id was assigned to a Campus and retained for compatibility.

Parametersosid.id.IdcampusId Id of the Campus
Returnosid.room.Campusthe campus
ErrorsNOT_FOUND campusId not found
NULL_ARGUMENT campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetCampusesByIds
Description

Gets a CampusList corresponding to the given IdList. In plenary mode, the returned list contains all of the campuses specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Campuses may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListcampusIdsthe list of Ids to retrieve
Returnosid.room.CampusListthe returned Campus list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT campusIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCampusesByGenusType
Description

Gets a CampusList corresponding to the given campus genus Type which does not include campuses of genus types derived from the specified Type. In plenary mode, the returned list contains all known campuses or an error results. Otherwise, the returned list may contain only those campuses that are accessible through this session.

Parametersosid.type.TypecampusGenusTypea campus genus type
Returnosid.room.CampusListthe returned Campus list
ErrorsNULL_ARGUMENT campusGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCampusesByParentGenusType
Description

Gets a CampusList corresponding to the given campus genus Type and include any additional campuses with genus types derived from the specified Type. In plenary mode, the returned list contains all known campuses or an error results. Otherwise, the returned list may contain only those campuses that are accessible through this session.

Parametersosid.type.TypecampusGenusTypea campus genus type
Returnosid.room.CampusListthe returned Campus list
ErrorsNULL_ARGUMENT campusGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCampusesByRecordType
Description

Gets a CampusList containing the given campus record Type. In plenary mode, the returned list contains all known campuses or an error results. Otherwise, the returned list may contain only those campuses that are accessible through this session.

Parametersosid.type.TypecampusRecordTypea campus record type
Returnosid.room.CampusListthe returned Campus list
ErrorsNULL_ARGUMENT campusRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCampusesByProvider
Description

Gets a CampusList for the given provider . In plenary mode, the returned list contains all known campuses or an error results. Otherwise, the returned list may contain only those campuses that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.room.CampusListthe returned Campus list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCampuses
Description

Gets all Campuses. In plenary mode, the returned list contains all known campuses or an error results. Otherwise, the returned list may contain only those campuses that are accessible through this session.

Returnosid.room.CampusLista list of Campuses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.