Interface RoomManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, RoomProfile, Sourceable

public interface RoomManager
extends OsidManager, RoomProfile

The room manager provides access to room sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• RoomLookupSession : a session to lookup rooms
• RoomQuerySession : a session to query rooms
• RoomSearchSession : a session to search rooms
• RoomAdminSession : a session to manage rooms
• RoomNotificationSession : a session to subscribe to notifications of room changes
• RoomCampusSession : a session to look up room campus mappings
• RoomCampusAssignmentSession : a session to manage room campus mappings
• RoomSmartCampusSession : a session to manage smart campuses of rooms

• FloorLookupSession : a session to retrieve floores
• FloorQuerySession : a session to query floores
• FloorSearchSession : a session to search for floores
• FloorAdminSession : a session to create, update and delete floores
• FloorNotificationSession : a session to receive notifications for changes in floores
• FloorCampusSession : a session to look up floor campus mappings
• FloorCampusAssignmentSession : a session to manage floor campus mappings
• FloorSmartCampusSession : a session to manage smart campuses of floores

• BuildingLookupSession : a session to retrieve buildinges
• BuildingQuerySession : a session to query buildinges
• BuildingSearchSession : a session to search for buildinges
• BuildingAdminSession : a session to create, update and delete buildinges
• BuildingNotificationSession : a session to receive notifications for changes in buildinges
• BuildingCampusSession : a session to look up building campus mappings
• BuildingCampusAssignmentSession : a session to manage building campus mappings
• BuildingSmartCampusSession : a session to manage smart campuses of buildinges

• CampusLookupSession : a session to retrieve campuss
• CampusQuerySession : a session to query campuss
• CampusSearchSession : a session to search for campuss
• CampusAdminSession : a session to create, update and delete campuss
• CampusNotificationSession : a session to receive notifications for changes in campuss
• CampusHierarchySession : a session to traverse hierarchies of campuss
• CampusHierarchyDesignSession : a session to manage hierarchies of campuses

The room manager also provides a profile for determing the supported search types supported by this service.

Method Summary

Modifier and Type	Method	Description
BuildingAdminSession	getBuildingAdminSession()	Gets the OsidSession associated with the building administrative service.
BuildingAdminSession	getBuildingAdminSessionForCampus(Id campusId)	Gets the OsidSession associated with the building administrative service for the given campus.
BuildingCampusAssignmentSession	getBuildingCampusAssignmentSession()	Gets the session for assigning building to campus mappings.
BuildingCampusSession	getBuildingCampusSession()	Gets the session for retrieving building to campus mappings.
BuildingLookupSession	getBuildingLookupSession()	Gets the OsidSession associated with the building lookup service.
BuildingLookupSession	getBuildingLookupSessionForCampus(Id campusId)	Gets the OsidSession associated with the building lookup service for the given campus.
BuildingNotificationSession	getBuildingNotificationSession(BuildingReceiver buildingReceiver)	Gets the OsidSession associated with the building notification service.
BuildingNotificationSession	getBuildingNotificationSessionForCampus(BuildingReceiver buildingReceiver, Id campusId)	Gets the OsidSession associated with the building notification service for the given campus.
BuildingQuerySession	getBuildingQuerySession()	Gets the OsidSession associated with the building query service.
BuildingQuerySession	getBuildingQuerySessionForCampus(Id campusId)	Gets the OsidSession associated with the building query service for the given campus.
BuildingSearchSession	getBuildingSearchSession()	Gets the OsidSession associated with the building search service.
BuildingSearchSession	getBuildingSearchSessionForCampus(Id campusId)	Gets the OsidSession associated with the building search service for the given campus.
BuildingSmartCampusSession	getBuildingSmartCampusSession(Id campusId)	Gets the session associated with the building smart campus for the given campus.
CampusAdminSession	getCampusAdminSession()	Gets the OsidSession associated with the campus administrative service.
CampusHierarchyDesignSession	getCampusHierarchyDesignSession()	Gets the OsidSession associated with the campus hierarchy design service.
CampusHierarchySession	getCampusHierarchySession()	Gets the OsidSession associated with the campus hierarchy service.
CampusLookupSession	getCampusLookupSession()	Gets the OsidSession associated with the campus lookup service.
CampusNotificationSession	getCampusNotificationSession(CampusReceiver campusReceiver)	Gets the OsidSession associated with the campus notification service.
CampusQuerySession	getCampusQuerySession()	Gets the OsidSession associated with the campus query service.
CampusSearchSession	getCampusSearchSession()	Gets the OsidSession associated with the campus search service.
FloorAdminSession	getFloorAdminSession()	Gets the OsidSession associated with the floor administrative service.
FloorAdminSession	getFloorAdminSessionForCampus(Id campusId)	Gets the OsidSession associated with the floor administrative service for the given campus.
FloorCampusAssignmentSession	getFloorCampusAssignmentSession()	Gets the session for assigning floor to campus mappings.
FloorCampusSession	getFloorCampusSession()	Gets the session for retrieving floor to campus mappings.
FloorLookupSession	getFloorLookupSession()	Gets the OsidSession associated with the floor lookup service.
FloorLookupSession	getFloorLookupSessionForCampus(Id campusId)	Gets the OsidSession associated with the floor lookup service for the given campus.
FloorNotificationSession	getFloorNotificationSession(FloorReceiver floorReceiver)	Gets the OsidSession associated with the floor notification service.
FloorNotificationSession	getFloorNotificationSessionForCampus(FloorReceiver floorReceiver, Id campusId)	Gets the OsidSession associated with the floor notification service for the given campus.
FloorQuerySession	getFloorQuerySession()	Gets the OsidSession associated with the floor query service.
FloorQuerySession	getFloorQuerySessionForCampus(Id campusId)	Gets the OsidSession associated with the floor query service for the given campus.
FloorSearchSession	getFloorSearchSession()	Gets the OsidSession associated with the floor search service.
FloorSearchSession	getFloorSearchSessionForCampus(Id campusId)	Gets the OsidSession associated with the floor search service for the given campus.
FloorSmartCampusSession	getFloorSmartCampusSession(Id campusId)	Gets the session associated with the floor smart campus for the given campus.
RoomAdminSession	getRoomAdminSession()	Gets the OsidSession associated with the room administration service.
RoomAdminSession	getRoomAdminSessionForCampus(Id campusId)	Gets the OsidSession associated with the room administration service for the given campus.
RoomBatchManager	getRoomBatchManager()	Gets the RoomBatchManager .
RoomCampusAssignmentSession	getRoomCampusAssignmentSession()	Gets the session for assigning room to campus mappings.
RoomCampusSession	getRoomCampusSession()	Gets the session for retrieving room to campus mappings.
RoomConstructionManager	getRoomConstructionManager()	Gets the RoomConstructionManager .
RoomLookupSession	getRoomLookupSession()	Gets the OsidSession associated with the room lookup service.
RoomLookupSession	getRoomLookupSessionForCampus(Id campusId)	Gets the OsidSession associated with the room lookup service for the given campus.
RoomNotificationSession	getRoomNotificationSession(RoomReceiver roomReceiver)	Gets the OsidSession associated with the room notification service.
RoomNotificationSession	getRoomNotificationSessionForCampus(RoomReceiver roomReceiver, Id campusId)	Gets the OsidSession associated with the room notification service for the given campus.
RoomQuerySession	getRoomQuerySession()	Gets the OsidSession associated with the room query service.
RoomQuerySession	getRoomQuerySessionForCampus(Id campusId)	Gets the OsidSession associated with the room query service for the given campus.
RoomSearchSession	getRoomSearchSession()	Gets the OsidSession associated with the room search service.
RoomSearchSession	getRoomSearchSessionForCampus(Id campusId)	Gets the OsidSession associated with the room search service for the given campus.
RoomSmartCampusSession	getRoomSmartCampusSession(Id campusId)	Gets the session associated with the room smart campus for the given campus.
RoomSquattingManager	getRoomSquattingManager()	Gets the RoomSquattingManager .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface RoomProfile

getBuildingRecordTypes, getBuildingSearchRecordTypes, getCampusRecordTypes, getCampusSearchRecordTypes, getFloorRecordTypes, getFloorSearchRecordTypes, getRoomRecordTypes, getRoomSearchRecordTypes, supportsBuildingAdmin, supportsBuildingCampus, supportsBuildingCampusAssignment, supportsBuildingLookup, supportsBuildingNotification, supportsBuildingQuery, supportsBuildingRecordType, supportsBuildingSearch, supportsBuildingSearchRecordType, supportsBuildingSmartCampus, supportsCampusAdmin, supportsCampusHierarchy, supportsCampusHierarchyDesign, supportsCampusLookup, supportsCampusNotification, supportsCampusQuery, supportsCampusRecordType, supportsCampusSearch, supportsCampusSearchRecordType, supportsFloorAdmin, supportsFloorCampus, supportsFloorCampusAssignment, supportsFloorLookup, supportsFloorNotification, supportsFloorQuery, supportsFloorRecordType, supportsFloorSearch, supportsFloorSearchRecordType, supportsFloorSmartCampus, supportsRoomAdmin, supportsRoomBatch, supportsRoomCampus, supportsRoomCampusAssignment, supportsRoomConstruction, supportsRoomLookup, supportsRoomNotification, supportsRoomQuery, supportsRoomRecordType, supportsRoomSearch, supportsRoomSearchRecordType, supportsRoomSmartCampus, supportsRoomSquatting, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getBuildingRecordTypes()	Gets the supported Building record types.
TypeList	getBuildingSearchRecordTypes()	Gets the supported building search record types.
TypeList	getCampusRecordTypes()	Gets the supported Campus record types.
TypeList	getCampusSearchRecordTypes()	Gets the supported campus search record types.
TypeList	getFloorRecordTypes()	Gets the supported Floor record types.
TypeList	getFloorSearchRecordTypes()	Gets the supported floor search record types.
TypeList	getRoomRecordTypes()	Gets the supported Room record types.
TypeList	getRoomSearchRecordTypes()	Gets the supported room search record types.
boolean	supportsBuildingAdmin()	Tests for the availability of a building administrative service for creating and deleting buildinges.
boolean	supportsBuildingCampus()	Tests if a building to campus lookup session is available.
boolean	supportsBuildingCampusAssignment()	Tests if a building to campus assignment session is available.
boolean	supportsBuildingLookup()	Tests for the availability of a building lookup service.
boolean	supportsBuildingNotification()	Tests for the availability of a building notification service.
boolean	supportsBuildingQuery()	Tests if querying buildinges is available.
boolean	supportsBuildingRecordType(Type buildingRecordType)	Tests if the given Building record type is supported.
boolean	supportsBuildingSearch()	Tests if searching for buildinges is available.
boolean	supportsBuildingSearchRecordType(Type buildingSearchRecordType)	Tests if the given building search record type is supported.
boolean	supportsBuildingSmartCampus()	Tests if a building smart campus session is available.
boolean	supportsCampusAdmin()	Tests for the availability of a campus administrative service for creating and deleting campuses.
boolean	supportsCampusHierarchy()	Tests for the availability of a campus hierarchy traversal service.
boolean	supportsCampusHierarchyDesign()	Tests for the availability of a campus hierarchy design service.
boolean	supportsCampusLookup()	Tests for the availability of a campus lookup service.
boolean	supportsCampusNotification()	Tests for the availability of a campus notification service.
boolean	supportsCampusQuery()	Tests if querying campuses is available.
boolean	supportsCampusRecordType(Type campusRecordType)	Tests if the given Campus record type is supported.
boolean	supportsCampusSearch()	Tests if searching for campuses is available.
boolean	supportsCampusSearchRecordType(Type campusSearchRecordType)	Tests if the given campus search record type is supported.
boolean	supportsFloorAdmin()	Tests for the availability of a floor administrative service for creating and deleting floores.
boolean	supportsFloorCampus()	Tests if a floor to campus lookup session is available.
boolean	supportsFloorCampusAssignment()	Tests if a floor to campus assignment session is available.
boolean	supportsFloorLookup()	Tests for the availability of a floor lookup service.
boolean	supportsFloorNotification()	Tests for the availability of a floor notification service.
boolean	supportsFloorQuery()	Tests if querying floores is available.
boolean	supportsFloorRecordType(Type floorRecordType)	Tests if the given Floor record type is supported.
boolean	supportsFloorSearch()	Tests if searching for floores is available.
boolean	supportsFloorSearchRecordType(Type floorSearchRecordType)	Tests if the given floor search record type is supported.
boolean	supportsFloorSmartCampus()	Tests if a floor smart campus session is available.
boolean	supportsRoomAdmin()	Tests if managing rooms is available.
boolean	supportsRoomBatch()	Tests for the availability of a room batch service.
boolean	supportsRoomCampus()	Tests if a room to campus lookup session is available.
boolean	supportsRoomCampusAssignment()	Tests if a room to campus assignment session is available.
boolean	supportsRoomConstruction()	Tests for the availability of a room construction service.
boolean	supportsRoomLookup()	Tests for the availability of a room lookup service.
boolean	supportsRoomNotification()	Tests if room notification is available.
boolean	supportsRoomQuery()	Tests if querying rooms is available.
boolean	supportsRoomRecordType(Type roomRecordType)	Tests if the given Room record type is supported.
boolean	supportsRoomSearch()	Tests if searching for rooms is available.
boolean	supportsRoomSearchRecordType(Type roomSearchRecordType)	Tests if the given room search record type is supported.
boolean	supportsRoomSmartCampus()	Tests if a room smart campus session is available.
boolean	supportsRoomSquatting()	Tests for the availability of a room squatting service.
boolean	supportsVisibleFederation()	Tests if any building federation is exposed.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getRoomLookupSession

RoomLookupSession getRoomLookupSession()
                                throws OperationFailedException

Gets the OsidSession associated with the room lookup service.

Returns:

a RoomLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsRoomLookup()} is {@code true} .

getRoomLookupSessionForCampus

RoomLookupSession getRoomLookupSessionForCampus(Id campusId)
                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the room lookup service for the given campus.

Parameters:

campusId - the Id of the Campus

Returns:

a RoomLookupSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRoomLookup()} and {@code supportsVisibleFederation()} are {@code true}

getRoomQuerySession

RoomQuerySession getRoomQuerySession()
                              throws OperationFailedException

Gets the OsidSession associated with the room query service.

Returns:

a RoomQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsRoomQuery()} is {@code true} .

getRoomQuerySessionForCampus

RoomQuerySession getRoomQuerySessionForCampus(Id campusId)
                                       throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the room query service for the given campus.

Parameters:

campusId - the Id of the Campus

Returns:

a RoomQuerySession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRoomQuery()} and {@code supportsVisibleFederation()} are {@code true}

getRoomSearchSession

RoomSearchSession getRoomSearchSession()
                                throws OperationFailedException

Gets the OsidSession associated with the room search service.

Returns:

a RoomSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsRoomSearch()} is {@code true} .

getRoomSearchSessionForCampus

RoomSearchSession getRoomSearchSessionForCampus(Id campusId)
                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the room search service for the given campus.

Parameters:

campusId - the Id of the Campus

Returns:

a RoomSearchSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRoomSearch()} and {@code supportsVisibleFederation()} are {@code true}

getRoomAdminSession

RoomAdminSession getRoomAdminSession()
                              throws OperationFailedException

Gets the OsidSession associated with the room administration service.

Returns:

a RoomAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsRoomAdmin()} is {@code true} .

getRoomAdminSessionForCampus

RoomAdminSession getRoomAdminSessionForCampus(Id campusId)
                                       throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the room administration service for the given campus.

Parameters:

campusId - the Id of the Campus

Returns:

a RoomAdminSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRoomAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getRoomNotificationSession

RoomNotificationSession getRoomNotificationSession(RoomReceiver roomReceiver)
                                            throws OperationFailedException

Gets the OsidSession associated with the room notification service.

Parameters:

roomReceiver - the receiver

Returns:

a RoomNotificationSession

Throws:

NullArgumentException - roomReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsRoomNotification()} is {@code true} .

getRoomNotificationSessionForCampus

RoomNotificationSession getRoomNotificationSessionForCampus(RoomReceiver roomReceiver,
 Id campusId)
                                                     throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the room notification service for the given campus.

Parameters:

roomReceiver - the receiver

campusId - the Id of the Campus

Returns:

a RoomNotificationSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - roomReceiver or campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRoomNotification()} and {@code supportsVisibleFederation()} are {@code true}

getRoomCampusSession

RoomCampusSession getRoomCampusSession()
                                throws OperationFailedException

Gets the session for retrieving room to campus mappings.

Returns:

a RoomCampusSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomCampus() is false

Compliance:

optional - This method must be implemented if {@code supportsRoomCampus()} is {@code true} .

getRoomCampusAssignmentSession

RoomCampusAssignmentSession getRoomCampusAssignmentSession()
                                                    throws OperationFailedException

Gets the session for assigning room to campus mappings.

Returns:

a RoomCampusAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomCampusAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsRoomCampusAssignment()} is {@code true} .

getRoomSmartCampusSession

RoomSmartCampusSession getRoomSmartCampusSession(Id campusId)
                                          throws NotFoundException,
OperationFailedException

Gets the session associated with the room smart campus for the given campus.

Parameters:

campusId - the Id of the campus

Returns:

a RoomSmartCampusSession

Throws:

NotFoundException - campusId not found

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomSmartCampus() is false

Compliance:

optional - This method must be implemented if {@code supportsRoomSmartCampus()} is {@code true} .

getFloorLookupSession

FloorLookupSession getFloorLookupSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the floor lookup service.

Returns:

a FloorLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFloorLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsFloorLookup()} is {@code true} .

getFloorLookupSessionForCampus

FloorLookupSession getFloorLookupSessionForCampus(Id campusId)
                                           throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the floor lookup service for the given campus.

Parameters:

campusId - the Id of the Floor

Returns:

a FloorLookupSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFloorLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsFloorLookup()} and {@code supportsVisibleFederation()} are {@code true}

getFloorQuerySession

FloorQuerySession getFloorQuerySession()
                                throws OperationFailedException

Gets the OsidSession associated with the floor query service.

Returns:

a FloorQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFloorQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsFloorQuery()} is {@code true} .

getFloorQuerySessionForCampus

FloorQuerySession getFloorQuerySessionForCampus(Id campusId)
                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the floor query service for the given campus.

Parameters:

campusId - the Id of the Floor

Returns:

a FloorQuerySession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFloorQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsFloorQuery()} and {@code supportsVisibleFederation()} are {@code true}

getFloorSearchSession

FloorSearchSession getFloorSearchSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the floor search service.

Returns:

a FloorSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFloorSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsFloorSearch()} is {@code true} .

getFloorSearchSessionForCampus

FloorSearchSession getFloorSearchSessionForCampus(Id campusId)
                                           throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the floor search service for the given campus.

Parameters:

campusId - the Id of the Floor

Returns:

a FloorSearchSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFloorSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsFloorSearch()} and {@code supportsVisibleFederation()} are {@code true}

getFloorAdminSession

FloorAdminSession getFloorAdminSession()
                                throws OperationFailedException

Gets the OsidSession associated with the floor administrative service.

Returns:

a FloorAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFloorAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsFloorAdmin()} is {@code true} .

getFloorAdminSessionForCampus

FloorAdminSession getFloorAdminSessionForCampus(Id campusId)
                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the floor administrative service for the given campus.

Parameters:

campusId - the Id of the Floor

Returns:

a FloorAdminSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFloorAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsFloorAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getFloorNotificationSession

FloorNotificationSession getFloorNotificationSession(FloorReceiver floorReceiver)
                                              throws OperationFailedException

Gets the OsidSession associated with the floor notification service.

Parameters:

floorReceiver - the receiver

Returns:

a FloorNotificationSession

Throws:

NullArgumentException - floorReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFloorNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsFloorNotification()} is {@code true} .

getFloorNotificationSessionForCampus

FloorNotificationSession getFloorNotificationSessionForCampus(FloorReceiver floorReceiver,
 Id campusId)
                                                       throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the floor notification service for the given campus.

Parameters:

floorReceiver - the receiver

campusId - the Id of the Campus

Returns:

a FloorNotificationSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - floorReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFloorNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsFloorNotification()} and {@code supportsVisibleFederation()} are {@code true}

getFloorCampusSession

FloorCampusSession getFloorCampusSession()
                                  throws OperationFailedException

Gets the session for retrieving floor to campus mappings.

Returns:

a FloorCampusSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFloorCampus() is false

Compliance:

optional - This method must be implemented if {@code supportsFloorCampus()} is {@code true} .

getFloorCampusAssignmentSession

FloorCampusAssignmentSession getFloorCampusAssignmentSession()
                                                      throws OperationFailedException

Gets the session for assigning floor to campus mappings.

Returns:

a FloorCampusAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFloorCampusAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsFloorCampusAssignment()} is {@code true} .

getFloorSmartCampusSession

FloorSmartCampusSession getFloorSmartCampusSession(Id campusId)
                                            throws NotFoundException,
OperationFailedException

Gets the session associated with the floor smart campus for the given campus.

Parameters:

campusId - the Id of the campus

Returns:

a FloorSmartCampusSession

Throws:

NotFoundException - campusId not found

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFloorSmartCampus() is false

Compliance:

optional - This method must be implemented if {@code supportsFloorSmartCampus()} is {@code true} .

getBuildingLookupSession

BuildingLookupSession getBuildingLookupSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the building lookup service.

Returns:

a BuildingLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBuildingLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsBuildingLookup()} is {@code true} .

getBuildingLookupSessionForCampus

BuildingLookupSession getBuildingLookupSessionForCampus(Id campusId)
                                                 throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the building lookup service for the given campus.

Parameters:

campusId - the Id of the Building

Returns:

a BuildingLookupSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBuildingLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBuildingLookup()} and {@code supportsVisibleFederation()} are {@code true}

getBuildingQuerySession

BuildingQuerySession getBuildingQuerySession()
                                      throws OperationFailedException

Gets the OsidSession associated with the building query service.

Returns:

a BuildingQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBuildingQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsBuildingQuery()} is {@code true} .

getBuildingQuerySessionForCampus

BuildingQuerySession getBuildingQuerySessionForCampus(Id campusId)
                                               throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the building query service for the given campus.

Parameters:

campusId - the Id of the Building

Returns:

a BuildingQuerySession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBuildingQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBuildingQuery()} and {@code supportsVisibleFederation()} are {@code true}

getBuildingSearchSession

BuildingSearchSession getBuildingSearchSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the building search service.

Returns:

a BuildingSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBuildingSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsBuildingSearch()} is {@code true} .

getBuildingSearchSessionForCampus

BuildingSearchSession getBuildingSearchSessionForCampus(Id campusId)
                                                 throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the building search service for the given campus.

Parameters:

campusId - the Id of the Building

Returns:

a BuildingSearchSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBuildingSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBuildingSearch()} and {@code supportsVisibleFederation()} are {@code true}

getBuildingAdminSession

BuildingAdminSession getBuildingAdminSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the building administrative service.

Returns:

a BuildingAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBuildingAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsBuildingAdmin()} is {@code true} .

getBuildingAdminSessionForCampus

BuildingAdminSession getBuildingAdminSessionForCampus(Id campusId)
                                               throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the building administrative service for the given campus.

Parameters:

campusId - the Id of the Building

Returns:

a BuildingAdminSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBuildingAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBuildingAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getBuildingNotificationSession

BuildingNotificationSession getBuildingNotificationSession(BuildingReceiver buildingReceiver)
                                                    throws OperationFailedException

Gets the OsidSession associated with the building notification service.

Parameters:

buildingReceiver - the receiver

Returns:

a BuildingNotificationSession

Throws:

NullArgumentException - buildingReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBuildingNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsBuildingNotification()} is {@code true} .

getBuildingNotificationSessionForCampus

BuildingNotificationSession getBuildingNotificationSessionForCampus(BuildingReceiver buildingReceiver,
 Id campusId)
                                                             throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the building notification service for the given campus.

Parameters:

buildingReceiver - the receiver

campusId - the Id of the Campus

Returns:

a BuildingNotificationSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - buildingReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBuildingNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBuildingNotification()} and {@code supportsVisibleFederation()} are {@code true}

getBuildingCampusSession

BuildingCampusSession getBuildingCampusSession()
                                        throws OperationFailedException

Gets the session for retrieving building to campus mappings.

Returns:

a BuildingCampusSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBuildingCampus() is false

Compliance:

optional - This method must be implemented if {@code supportsBuildingCampus()} is {@code true} .

getBuildingCampusAssignmentSession

BuildingCampusAssignmentSession getBuildingCampusAssignmentSession()
                                                            throws OperationFailedException

Gets the session for assigning building to campus mappings.

Returns:

a BuildingCampusAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBuildingCampusAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsBuildingCampusAssignment()} is {@code true} .

getBuildingSmartCampusSession

BuildingSmartCampusSession getBuildingSmartCampusSession(Id campusId)
                                                  throws NotFoundException,
OperationFailedException

Gets the session associated with the building smart campus for the given campus.

Parameters:

campusId - the Id of the campus

Returns:

a BuildingSmartCampusSession

Throws:

NotFoundException - campusId not found

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBuildingSmartCampus() is false

Compliance:

optional - This method must be implemented if {@code supportsBuildingSmartCampus()} is {@code true} .

getCampusLookupSession

CampusLookupSession getCampusLookupSession()
                                    throws OperationFailedException

Gets the OsidSession associated with the campus lookup service.

Returns:

a CampusLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCampusLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsCampusLookup()} is {@code true} .

getCampusQuerySession

CampusQuerySession getCampusQuerySession()
                                  throws OperationFailedException

Gets the OsidSession associated with the campus query service.

Returns:

a CampusQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCampusQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCampusQuery()} is {@code true} .

getCampusSearchSession

CampusSearchSession getCampusSearchSession()
                                    throws OperationFailedException

Gets the OsidSession associated with the campus search service.

Returns:

a CampusSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCampusSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsCampusSearch()} is {@code true} .

getCampusAdminSession

CampusAdminSession getCampusAdminSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the campus administrative service.

Returns:

a CampusAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCampusAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsCampusAdmin()} is {@code true} .

getCampusNotificationSession

CampusNotificationSession getCampusNotificationSession(CampusReceiver campusReceiver)
                                                throws OperationFailedException

Gets the OsidSession associated with the campus notification service.

Parameters:

campusReceiver - the receiver

Returns:

a CampusNotificationSession

Throws:

NullArgumentException - campusReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCampusNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsCampusNotification()} is {@code true} .

getCampusHierarchySession

CampusHierarchySession getCampusHierarchySession()
                                          throws OperationFailedException

Gets the OsidSession associated with the campus hierarchy service.

Returns:

a CampusHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCampusHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsCampusHierarchy()} is {@code true} .

getCampusHierarchyDesignSession

CampusHierarchyDesignSession getCampusHierarchyDesignSession()
                                                      throws OperationFailedException

Gets the OsidSession associated with the campus hierarchy design service.

Returns:

a CampusHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCampusHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsCampusHierarchyDesign()} is {@code true} .

getRoomBatchManager

RoomBatchManager getRoomBatchManager()
                              throws OperationFailedException

Gets the RoomBatchManager .

Returns:

a RoomBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRoombatch() is false

Compliance:

optional - This method must be implemented if {@code supportsRoombatch()} is {@code true} .

getRoomConstructionManager

RoomConstructionManager getRoomConstructionManager()
                                            throws OperationFailedException

Gets the RoomConstructionManager .

Returns:

a RoomConstructionManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomConstruction() is false

Compliance:

optional - This method must be implemented if {@code supportsRoomConstruction()} is {@code true} .

getRoomSquattingManager

RoomSquattingManager getRoomSquattingManager()
                                      throws OperationFailedException

Gets the RoomSquattingManager .

Returns:

a RoomSquattingManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomSquatting() is false

Compliance:

optional - This method must be implemented if {@code supportsRoomSquatting()} is {@code true} .