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.
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. |
changeBranch, initialize, rollbackService
close
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
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
RoomLookupSession getRoomLookupSession() throws OperationFailedException
OsidSession
associated with the room lookup
service. RoomLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRoomLookup()
is false
optional
- This method must be implemented if
supportsRoomLookup()
is true.
RoomLookupSession getRoomLookupSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the room lookup
service for the given campus.campusId
- the Id
of the Campus
RoomLookupSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRoomLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRoomLookup()
and
supportsVisibleFederation()
are true
RoomQuerySession getRoomQuerySession() throws OperationFailedException
OsidSession
associated with the room query
service. RoomQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRoomQuery()
is false
optional
- This method must be implemented if
supportsRoomQuery()
is true.
RoomQuerySession getRoomQuerySessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the room query
service for the given campus.campusId
- the Id
of the Campus
RoomQuerySession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRoomQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRoomQuery()
and
supportsVisibleFederation()
are true
RoomSearchSession getRoomSearchSession() throws OperationFailedException
OsidSession
associated with the room search
service. RoomSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRoomSearch()
is false
optional
- This method must be implemented if
supportsRoomSearch()
is true.
RoomSearchSession getRoomSearchSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the room search
service for the given campus.campusId
- the Id
of the Campus
RoomSearchSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRoomSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRoomSearch()
and
supportsVisibleFederation()
are true
RoomAdminSession getRoomAdminSession() throws OperationFailedException
OsidSession
associated with the room
administration service. RoomAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRoomAdmin()
is false
optional
- This method must be implemented if
supportsRoomAdmin()
is true.
RoomAdminSession getRoomAdminSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the room
administration service for the given campus.campusId
- the Id
of the Campus
RoomAdminSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRoomAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRoomAdmin()
and
supportsVisibleFederation()
are true
RoomNotificationSession getRoomNotificationSession(RoomReceiver roomReceiver) throws OperationFailedException
OsidSession
associated with the room
notification service.roomReceiver
- the receiver RoomNotificationSession
NullArgumentException
- roomReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRoomNotification()
is false
optional
- This method must be implemented if
supportsRoomNotification()
is true.
RoomNotificationSession getRoomNotificationSessionForCampus(RoomReceiver roomReceiver, Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the room
notification service for the given campus.roomReceiver
- the receivercampusId
- the Id
of the Campus
RoomNotificationSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- roomReceiver
or
campusId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRoomNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRoomNotification()
and
supportsVisibleFederation()
are true
RoomCampusSession getRoomCampusSession() throws OperationFailedException
RoomCampusSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRoomCampus()
is false
optional
- This method must be implemented if
supportsRoomCampus()
is true.
RoomCampusAssignmentSession getRoomCampusAssignmentSession() throws OperationFailedException
RoomCampusAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRoomCampusAssignment()
is false
optional
- This method must be implemented if
supportsRoomCampusAssignment()
is true.
RoomSmartCampusSession getRoomSmartCampusSession(Id campusId) throws NotFoundException, OperationFailedException
campusId
- the Id
of the campus RoomSmartCampusSession
NotFoundException
- campusId
not foundNullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRoomSmartCampus()
is false
optional
- This method must be implemented if
supportsRoomSmartCampus()
is true.
FloorLookupSession getFloorLookupSession() throws OperationFailedException
OsidSession
associated with the floor lookup
service. FloorLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFloorLookup()
is false
optional
- This method must be implemented if
supportsFloorLookup()
is true.
FloorLookupSession getFloorLookupSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the floor lookup
service for the given campus.campusId
- the Id
of the Floor
FloorLookupSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFloorLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsFloorLookup()
and
supportsVisibleFederation()
are true
FloorQuerySession getFloorQuerySession() throws OperationFailedException
OsidSession
associated with the floor query
service. FloorQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFloorQuery()
is false
optional
- This method must be implemented if
supportsFloorQuery()
is true.
FloorQuerySession getFloorQuerySessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the floor query
service for the given campus.campusId
- the Id
of the Floor
FloorQuerySession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFloorQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsFloorQuery()
and
supportsVisibleFederation()
are true
FloorSearchSession getFloorSearchSession() throws OperationFailedException
OsidSession
associated with the floor search
service. FloorSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFloorSearch()
is false
optional
- This method must be implemented if
supportsFloorSearch()
is true.
FloorSearchSession getFloorSearchSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the floor search
service for the given campus.campusId
- the Id
of the Floor
FloorSearchSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFloorSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsFloorSearch()
and
supportsVisibleFederation()
are true
FloorAdminSession getFloorAdminSession() throws OperationFailedException
OsidSession
associated with the floor
administrative service. FloorAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFloorAdmin()
is false
optional
- This method must be implemented if
supportsFloorAdmin()
is true.
FloorAdminSession getFloorAdminSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the floor
administrative service for the given campus.campusId
- the Id
of the Floor
FloorAdminSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFloorAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsFloorAdmin()
and
supportsVisibleFederation()
are true
FloorNotificationSession getFloorNotificationSession(FloorReceiver floorReceiver) throws OperationFailedException
OsidSession
associated with the floor
notification service.floorReceiver
- the receiver FloorNotificationSession
NullArgumentException
- floorReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFloorNotification()
is false
optional
- This method must be implemented if
supportsFloorNotification()
is true.
FloorNotificationSession getFloorNotificationSessionForCampus(FloorReceiver floorReceiver, Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the floor
notification service for the given campus.floorReceiver
- the receivercampusId
- the Id
of the Campus
FloorNotificationSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- floorReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFloorNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsFloorNotification()
and
supportsVisibleFederation()
are true
FloorCampusSession getFloorCampusSession() throws OperationFailedException
FloorCampusSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFloorCampus()
is false
optional
- This method must be implemented if
supportsFloorCampus()
is true.
FloorCampusAssignmentSession getFloorCampusAssignmentSession() throws OperationFailedException
FloorCampusAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFloorCampusAssignment()
is false
optional
- This method must be implemented if
supportsFloorCampusAssignment()
is true.
FloorSmartCampusSession getFloorSmartCampusSession(Id campusId) throws NotFoundException, OperationFailedException
campusId
- the Id
of the campus FloorSmartCampusSession
NotFoundException
- campusId
not foundNullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFloorSmartCampus()
is false
optional
- This method must be implemented if
supportsFloorSmartCampus()
is true.
BuildingLookupSession getBuildingLookupSession() throws OperationFailedException
OsidSession
associated with the building
lookup service. BuildingLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBuildingLookup()
is false
optional
- This method must be implemented if
supportsBuildingLookup()
is true.
BuildingLookupSession getBuildingLookupSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the building
lookup service for the given campus.campusId
- the Id
of the Building
BuildingLookupSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBuildingLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsBuildingLookup()
and
supportsVisibleFederation()
are true
BuildingQuerySession getBuildingQuerySession() throws OperationFailedException
OsidSession
associated with the building query
service. BuildingQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBuildingQuery()
is false
optional
- This method must be implemented if
supportsBuildingQuery()
is true.
BuildingQuerySession getBuildingQuerySessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the building query
service for the given campus.campusId
- the Id
of the Building
BuildingQuerySession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBuildingQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsBuildingQuery()
and
supportsVisibleFederation()
are true
BuildingSearchSession getBuildingSearchSession() throws OperationFailedException
OsidSession
associated with the building
search service. BuildingSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBuildingSearch()
is false
optional
- This method must be implemented if
supportsBuildingSearch()
is true.
BuildingSearchSession getBuildingSearchSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the building
search service for the given campus.campusId
- the Id
of the Building
BuildingSearchSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBuildingSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsBuildingSearch()
and
supportsVisibleFederation()
are true
BuildingAdminSession getBuildingAdminSession() throws OperationFailedException
OsidSession
associated with the building
administrative service. BuildingAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBuildingAdmin()
is false
optional
- This method must be implemented if
supportsBuildingAdmin()
is true.
BuildingAdminSession getBuildingAdminSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the building
administrative service for the given campus.campusId
- the Id
of the Building
BuildingAdminSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBuildingAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsBuildingAdmin()
and
supportsVisibleFederation()
are true
BuildingNotificationSession getBuildingNotificationSession(BuildingReceiver buildingReceiver) throws OperationFailedException
OsidSession
associated with the building
notification service.buildingReceiver
- the receiver BuildingNotificationSession
NullArgumentException
- buildingReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBuildingNotification()
is false
optional
- This method must be implemented if
supportsBuildingNotification()
is true.
BuildingNotificationSession getBuildingNotificationSessionForCampus(BuildingReceiver buildingReceiver, Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the building
notification service for the given campus.buildingReceiver
- the receivercampusId
- the Id
of the Campus
BuildingNotificationSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- buildingReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBuildingNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsBuildingNotification()
and
supportsVisibleFederation()
are true
BuildingCampusSession getBuildingCampusSession() throws OperationFailedException
BuildingCampusSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBuildingCampus()
is false
optional
- This method must be implemented if
supportsBuildingCampus()
is true.
BuildingCampusAssignmentSession getBuildingCampusAssignmentSession() throws OperationFailedException
BuildingCampusAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBuildingCampusAssignment()
is false
optional
- This method must be implemented if
supportsBuildingCampusAssignment()
is true.
BuildingSmartCampusSession getBuildingSmartCampusSession(Id campusId) throws NotFoundException, OperationFailedException
campusId
- the Id
of the campus BuildingSmartCampusSession
NotFoundException
- campusId
not foundNullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBuildingSmartCampus()
is false
optional
- This method must be implemented if
supportsBuildingSmartCampus()
is true.
CampusLookupSession getCampusLookupSession() throws OperationFailedException
OsidSession
associated with the campus lookup
service. CampusLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCampusLookup()
is false
optional
- This method must be implemented if
supportsCampusLookup()
is true.
CampusQuerySession getCampusQuerySession() throws OperationFailedException
OsidSession
associated with the campus query
service. CampusQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCampusQuery()
is false
optional
- This method must be implemented if
supportsCampusQuery()
is true.
CampusSearchSession getCampusSearchSession() throws OperationFailedException
OsidSession
associated with the campus search
service. CampusSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCampusSearch()
is false
optional
- This method must be implemented if
supportsCampusSearch()
is true.
CampusAdminSession getCampusAdminSession() throws OperationFailedException
OsidSession
associated with the campus
administrative service. CampusAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCampusAdmin()
is false
optional
- This method must be implemented if
supportsCampusAdmin()
is true.
CampusNotificationSession getCampusNotificationSession(CampusReceiver campusReceiver) throws OperationFailedException
OsidSession
associated with the campus
notification service.campusReceiver
- the receiver CampusNotificationSession
NullArgumentException
- campusReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCampusNotification()
is false
optional
- This method must be implemented if
supportsCampusNotification()
is true.
CampusHierarchySession getCampusHierarchySession() throws OperationFailedException
OsidSession
associated with the campus
hierarchy service. CampusHierarchySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCampusHierarchy()
is false
optional
- This method must be implemented if
supportsCampusHierarchy()
is true.
CampusHierarchyDesignSession getCampusHierarchyDesignSession() throws OperationFailedException
OsidSession
associated with the campus
hierarchy design service. CampusHierarchyDesignSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCampusHierarchyDesign()
is false
optional
- This method must be implemented if
supportsCampusHierarchyDesign()
is true.
RoomBatchManager getRoomBatchManager() throws OperationFailedException
RoomBatchManager.
RoomBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRoombatch()
is false
optional
- This method must be implemented if
supportsRoombatch()
is true.
RoomConstructionManager getRoomConstructionManager() throws OperationFailedException
RoomConstructionManager.
RoomConstructionManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRoomConstruction()
is false
optional
- This method must be implemented if
supportsRoomConstruction()
is true.
RoomSquattingManager getRoomSquattingManager() throws OperationFailedException
RoomSquattingManager.
RoomSquattingManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRoomSquatting()
is false
optional
- This method must be implemented if
supportsRoomSquatting()
is true.