org.osid.room

Interface RoomProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidProfile, OsidProxyManager, RoomProfile, Sourceable

public interface RoomProxyManager
extends OsidProxyManager, RoomProfile

The room manager provides access to room sessions and provides interoperability tests for various aspects of this service. Methods in this manager accept a Proxy for passing information from a server environment. 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(Proxy proxy) Gets the OsidSession associated with the building administrative service.
BuildingAdminSession	getBuildingAdminSessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the building administration service for the given campus.
BuildingCampusAssignmentSession	getBuildingCampusAssignmentSession(Proxy proxy) Gets the session for assigning building to campus mappings.
BuildingCampusSession	getBuildingCampusSession(Proxy proxy) Gets the session for retrieving building to campus mappings.
BuildingLookupSession	getBuildingLookupSession(Proxy proxy) Gets the OsidSession associated with the building lookup service.
BuildingLookupSession	getBuildingLookupSessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the building lookup service for the given campus.
BuildingNotificationSession	getBuildingNotificationSession(BuildingReceiver buildingReceiver, Proxy proxy) Gets the OsidSession associated with the building notification service.
BuildingNotificationSession	getBuildingNotificationSessionForCampus(BuildingReceiver buildingReceiver, Id campusId, Proxy proxy) Gets the OsidSession associated with the building notification service for the given campus.
BuildingQuerySession	getBuildingQuerySession(Proxy proxy) Gets the OsidSession associated with the building query service.
BuildingQuerySession	getBuildingQuerySessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the building query service for the given campus.
BuildingSearchSession	getBuildingSearchSession(Proxy proxy) Gets the OsidSession associated with the building search service.
BuildingSearchSession	getBuildingSearchSessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the building search service for the given campus.
BuildingSmartCampusSession	getBuildingSmartCampusSession(Id campusId, Proxy proxy) Gets the session for managing dynamic building campuses for the given campus.
CampusAdminSession	getCampusAdminSession(Proxy proxy) Gets the OsidSession associated with the campus administrative service.
CampusHierarchyDesignSession	getCampusHierarchyDesignSession(Proxy proxy) Gets the OsidSession associated with the campus hierarchy design service.
CampusHierarchySession	getCampusHierarchySession(Proxy proxy) Gets the OsidSession associated with the campus hierarchy service.
CampusLookupSession	getCampusLookupSession(Proxy proxy) Gets the OsidSession associated with the campus lookup service.
CampusNotificationSession	getCampusNotificationSession(CampusReceiver campusReceiver, Proxy proxy) Gets the OsidSession associated with the campus notification service.
CampusQuerySession	getCampusQuerySession(Proxy proxy) Gets the OsidSession associated with the campus query service.
CampusSearchSession	getCampusSearchSession(Proxy proxy) Gets the OsidSession associated with the campus search service.
FloorAdminSession	getFloorAdminSession(Proxy proxy) Gets the OsidSession associated with the floor administrative service.
FloorAdminSession	getFloorAdminSessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the floor administration service for the given campus.
FloorCampusAssignmentSession	getFloorCampusAssignmentSession(Proxy proxy) Gets the session for assigning floor to campus mappings.
FloorCampusSession	getFloorCampusSession(Proxy proxy) Gets the session for retrieving floor to campus mappings.
FloorLookupSession	getFloorLookupSession(Proxy proxy) Gets the OsidSession associated with the floor lookup service.
FloorLookupSession	getFloorLookupSessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the floor lookup service for the given campus.
FloorNotificationSession	getFloorNotificationSession(FloorReceiver floorReceiver, Proxy proxy) Gets the OsidSession associated with the floor notification service.
FloorNotificationSession	getFloorNotificationSessionForCampus(FloorReceiver floorReceiver, Id campusId, Proxy proxy) Gets the OsidSession associated with the floor notification service for the given campus.
FloorQuerySession	getFloorQuerySession(Proxy proxy) Gets the OsidSession associated with the floor query service.
FloorQuerySession	getFloorQuerySessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the floor query service for the given campus.
FloorSearchSession	getFloorSearchSession(Proxy proxy) Gets the OsidSession associated with the floor search service.
FloorSearchSession	getFloorSearchSessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the floor search service for the given campus.
FloorSmartCampusSession	getFloorSmartCampusSession(Id campusId, Proxy proxy) Gets the session for managing dynamic floor campuses for the given campus.
RoomAdminSession	getRoomAdminSession(Proxy proxy) Gets the OsidSession associated with the room administration service.
RoomAdminSession	getRoomAdminSessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the room administration service for the given campus.
RoomBatchProxyManager	getRoomBatchProxyManager() Gets the RoomBatchProxyManager.
RoomCampusAssignmentSession	getRoomCampusAssignmentSession(Proxy proxy) Gets the session for assigning room to campus mappings.
RoomCampusSession	getRoomCampusSession(Proxy proxy) Gets the session for retrieving room to campus mappings.
RoomConstructionProxyManager	getRoomConstructionProxyManager() Gets the RoomConstructionProxyManager.
RoomLookupSession	getRoomLookupSession(Proxy proxy) Gets the OsidSession associated with the room lookup service.
RoomLookupSession	getRoomLookupSessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the room lookup service for the given campus.
RoomNotificationSession	getRoomNotificationSession(RoomReceiver roomReceiver, Proxy proxy) Gets the OsidSession associated with the room notification service.
RoomNotificationSession	getRoomNotificationSessionForCampus(RoomReceiver roomReceiver, Id campusId, Proxy proxy) Gets the OsidSession associated with the room notification service for the given campus.
RoomQuerySession	getRoomQuerySession(Proxy proxy) Gets the OsidSession associated with the room query service.
RoomQuerySession	getRoomQuerySessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the room query service for the given campus.
RoomSearchSession	getRoomSearchSession(Proxy proxy) Gets the OsidSession associated with the room search service.
RoomSearchSession	getRoomSearchSessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the room search service for the given campus.
RoomSmartCampusSession	getRoomSmartCampusSession(Id campusId, Proxy proxy) Gets the session associated with the room smart campus for the given campus.
RoomSquattingProxyManager	getRoomSquattingProxyManager() Gets the RoomSquattingProxyManager.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the room lookup service.

Parameters:

proxy - a proxy

Returns:

a RoomLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a RoomLookupSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId or proxy 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(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the room query service.

Parameters:

proxy - a proxy

Returns:

a RoomQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                            Proxy proxy)
                                              throws NotFoundException,
                                                     OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a RoomQuerySession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the room search service.

Parameters:

proxy - a proxy

Returns:

a RoomSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a RoomSearchSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId or proxy 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(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the room administration service.

Parameters:

proxy - a proxy

Returns:

a RoomAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                            Proxy proxy)
                                              throws NotFoundException,
                                                     OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a RoomAdminSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId or proxy 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,
                                                 Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the room notification service.

Parameters:

roomReceiver - the receiver

proxy - a proxy

Returns:

a RoomNotificationSession

Throws:

NullArgumentException - roomReceiver or proxy 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,
                                                          Proxy proxy)
                                                            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

proxy - a proxy

Returns:

a RoomNotificationSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - roomReceiver, campusId, or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the session for retrieving room to campus mappings.

Parameters:

proxy - a proxy

Returns:

a RoomCampusSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomCampus() is false

Compliance:

optional - This method must be implemented if supportsRoomCampus() is true.

getRoomCampusAssignmentSession

RoomCampusAssignmentSession getRoomCampusAssignmentSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the session for assigning room to campus mappings.

Parameters:

proxy - a proxy

Returns:

a RoomCampusAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                               Proxy proxy)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

campusId - the Id of the campus

proxy - a proxy

Returns:

a RoomSmartCampusSession

Throws:

NotFoundException - campusId not found

NullArgumentException - campusId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the floor lookup service.

Parameters:

proxy - a proxy

Returns:

a FloorLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a FloorLookupSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the floor query service.

Parameters:

proxy - a proxy

Returns:

a FloorQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a FloorQuerySession

Throws:

NotFoundException - no Floor found by the given Id

NullArgumentException - campusId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the floor search service.

Parameters:

proxy - a proxy

Returns:

a FloorSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a FloorSearchSession

Throws:

NotFoundException - no Floor found by the given Id

NullArgumentException - campusId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the floor administrative service.

Parameters:

proxy - a proxy

Returns:

a FloorAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a FloorAdminSession

Throws:

NotFoundException - no Floor found by the given Id

NullArgumentException - campusId or proxy 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,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the floor notification service.

Parameters:

floorReceiver - the receiver

proxy - a proxy

Returns:

a FloorNotificationSession

Throws:

NullArgumentException - floorReceiver or proxy 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,
                                                            Proxy proxy)
                                                              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

proxy - a proxy

Returns:

a FloorNotificationSession

Throws:

NotFoundException - no Floor found by the given Id

NullArgumentException - floorReceiver, campusId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets the session for retrieving floor to campus mappings.

Parameters:

proxy - a proxy

Returns:

a FloorCampusSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFloorCampus() is false

Compliance:

optional - This method must be implemented if supportsFloorCampus() is true.

getFloorCampusAssignmentSession

FloorCampusAssignmentSession getFloorCampusAssignmentSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the session for assigning floor to campus mappings.

Parameters:

proxy - a proxy

Returns:

a FloorCampusAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the session for managing dynamic floor campuses for the given campus.

Parameters:

campusId - the Id of a campus

proxy - a proxy

Returns:

a FloorSmartCampusSession

Throws:

NotFoundException - campusId not found

NullArgumentException - campusId or proxy 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(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the building lookup service.

Parameters:

proxy - a proxy

Returns:

a BuildingLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                      Proxy proxy)
                                                        throws NotFoundException,
                                                               OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a BuildingLookupSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId or proxy 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(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the building query service.

Parameters:

proxy - a proxy

Returns:

a BuildingQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a BuildingQuerySession

Throws:

NotFoundException - no Building found by the given Id

NullArgumentException - campusId or proxy 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(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the building search service.

Parameters:

proxy - a proxy

Returns:

a BuildingSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                      Proxy proxy)
                                                        throws NotFoundException,
                                                               OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a BuildingSearchSession

Throws:

NotFoundException - no Building found by the given Id

NullArgumentException - campusId or proxy 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(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the building administrative service.

Parameters:

proxy - a proxy

Returns:

a BuildingAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a BuildingAdminSession

Throws:

NotFoundException - no Building found by the given Id

NullArgumentException - campusId or proxy 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,
                                                         Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the building notification service.

Parameters:

buildingReceiver - the receiver

proxy - a proxy

Returns:

a BuildingNotificationSession

Throws:

NullArgumentException - buildingReceiver or proxy 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,
                                                                  Proxy proxy)
                                                                    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

proxy - a proxy

Returns:

a BuildingNotificationSession

Throws:

NotFoundException - no Building found by the given Id

NullArgumentException - buildingReceiver, campusId or proxy 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(Proxy proxy)
                                               throws OperationFailedException

Gets the session for retrieving building to campus mappings.

Parameters:

proxy - a proxy

Returns:

a BuildingCampusSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBuildingCampus() is false

Compliance:

optional - This method must be implemented if supportsBuildingCampus() is true.

getBuildingCampusAssignmentSession

BuildingCampusAssignmentSession getBuildingCampusAssignmentSession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the session for assigning building to campus mappings.

Parameters:

proxy - a proxy

Returns:

a BuildingCampusAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the session for managing dynamic building campuses for the given campus.

Parameters:

campusId - the Id of a campus

proxy - a proxy

Returns:

a BuildingSmartCampusSession

Throws:

NotFoundException - campusId not found

NullArgumentException - campusId or proxy 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(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the campus lookup service.

Parameters:

proxy - a proxy

Returns:

a CampusLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCampusLookup() is false

Compliance:

optional - This method must be implemented if supportsCampusLookup() is true.

getCampusQuerySession

CampusQuerySession getCampusQuerySession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the campus query service.

Parameters:

proxy - a proxy

Returns:

a CampusQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCampusQuery() is false

Compliance:

optional - This method must be implemented if supportsCampusQuery() is true.

getCampusSearchSession

CampusSearchSession getCampusSearchSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the campus search service.

Parameters:

proxy - a proxy

Returns:

a CampusSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCampusSearch() is false

Compliance:

optional - This method must be implemented if supportsCampusSearch() is true.

getCampusAdminSession

CampusAdminSession getCampusAdminSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the campus administrative service.

Parameters:

proxy - a proxy

Returns:

a CampusAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                     Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the campus notification service.

Parameters:

campusReceiver - the receiver

proxy - a proxy

Returns:

a CampusNotificationSession

Throws:

NullArgumentException - campusReceiver or proxy 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(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the campus hierarchy service.

Parameters:

proxy - a proxy

Returns:

a CampusHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCampusHierarchy() is false

Compliance:

optional - This method must be implemented if supportsCampusHierarchy() is true.

getCampusHierarchyDesignSession

CampusHierarchyDesignSession getCampusHierarchyDesignSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the campus hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a CampusHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCampusHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsCampusHierarchyDesign() is true.

getRoomBatchProxyManager

RoomBatchProxyManager getRoomBatchProxyManager()
                                               throws OperationFailedException

Gets the RoomBatchProxyManager.

Returns:

a RoomBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomRules() is false

Compliance:

optional - This method must be implemented if supportsRoomRules() is true.

getRoomConstructionProxyManager

RoomConstructionProxyManager getRoomConstructionProxyManager()
                                                             throws OperationFailedException

Gets the RoomConstructionProxyManager.

Returns:

a RoomConstructionProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomConstruction() is false

Compliance:

optional - This method must be implemented if supportsRoomConstruction() is true.

getRoomSquattingProxyManager

RoomSquattingProxyManager getRoomSquattingProxyManager()
                                                       throws OperationFailedException

Gets the RoomSquattingProxyManager.

Returns:

a RoomSquattingProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomSquatting() is false

Compliance:

optional - This method must be implemented if supportsRoomSquatting() is true.