org.osid.room

Interface Campus

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Campus
extends OsidCatalog

A Campus represents a collection of rooms. Like all OSID objects, a Campus is identified by its Id and any persisted references should use the Id.

Method Summary

Methods

Modifier and Type	Method and Description
CampusRecord	getCampusRecord(Type campusRecordType) Gets the campus record corresponding to the given Campus record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getCampusRecord

CampusRecord getCampusRecord(Type campusRecordType)
                             throws OperationFailedException

Gets the campus record corresponding to the given Campus record Type. This method is used to retrieve an object implementing the requested record. The campusRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(campusRecordType) is true .

Parameters:

campusRecordType - the type of campus record to retrieve

Returns:

the campus record

Throws:

NullArgumentException - campusRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(campusRecordType) is false

Compliance:

mandatory - This method must be implemented.