org.osid.room

Interface RoomManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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 org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.room.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

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

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 supportsRoomLookup() is 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 supportsRoomLookup() and supportsVisibleFederation() are 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 supportsRoomQuery() is 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 supportsRoomQuery() and supportsVisibleFederation() are 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 supportsRoomSearch() is 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 supportsRoomSearch() and supportsVisibleFederation() are 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 supportsRoomAdmin() is 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 supportsRoomAdmin() and supportsVisibleFederation() are 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 supportsRoomNotification() is 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 supportsRoomNotification() and supportsVisibleFederation() are 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 supportsRoomCampus() is 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 supportsRoomCampusAssignment() is 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 supportsRoomSmartCampus() is 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 supportsFloorLookup() is 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 supportsFloorLookup() and supportsVisibleFederation() are 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 supportsFloorQuery() is 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 supportsFloorQuery() and supportsVisibleFederation() are 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 supportsFloorSearch() is 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 supportsFloorSearch() and supportsVisibleFederation() are 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 supportsFloorAdmin() is 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 supportsFloorAdmin() and supportsVisibleFederation() are 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 supportsFloorNotification() is 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 supportsFloorNotification() and supportsVisibleFederation() are 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 supportsFloorCampus() is 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 supportsFloorCampusAssignment() is 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 supportsFloorSmartCampus() is 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 supportsBuildingLookup() is 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 supportsBuildingLookup() and supportsVisibleFederation() are 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 supportsBuildingQuery() is 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 supportsBuildingQuery() and supportsVisibleFederation() are 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 supportsBuildingSearch() is 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 supportsBuildingSearch() and supportsVisibleFederation() are 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 supportsBuildingAdmin() is 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 supportsBuildingAdmin() and supportsVisibleFederation() are 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 supportsBuildingNotification() is 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 supportsBuildingNotification() and supportsVisibleFederation() are 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 supportsBuildingCampus() is 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 supportsBuildingCampusAssignment() is 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 supportsBuildingSmartCampus() is 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 supportsCampusLookup() is 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 supportsCampusQuery() is 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 supportsCampusSearch() is 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 supportsCampusAdmin() is 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 supportsCampusNotification() is 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 supportsCampusHierarchy() is 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 supportsCampusHierarchyDesign() is 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 supportsRoombatch() is 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 supportsRoomConstruction() is 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 supportsRoomSquatting() is true.