public interface RoomBatchManager extends OsidManager, RoomBatchProfile
The room batch manager provides access to room batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
RoomBatchAdminSession:
a session to create, modify
and delete Rooms in bulk FloorBatchAdminSession:
a session to create,
modify and delete Floors in bulk
BuildingBatchAdminSession:
a session to create,
modify and delete Buildings
in bulk CampusBatchAdminSession:
a session to create,
modify and delete Campuses
in bulk Modifier and Type | Method and Description |
---|---|
BuildingBatchAdminSession |
getBuildingBatchAdminSession()
Gets the
OsidSession associated with the bulk building
administration service. |
BuildingBatchAdminSession |
getBuildingBatchAdminSessionForCampus(Id campusId)
Gets the
OsidSession associated with the bulk building
administration service for the given campus. |
CampusBatchAdminSession |
getCampusBatchAdminSession()
Gets the
OsidSession associated with the bulk campus
administration service. |
FloorBatchAdminSession |
getFloorBatchAdminSession()
Gets the
OsidSession associated with the bulk floor
administration service. |
FloorBatchAdminSession |
getFloorBatchAdminSessionForCampus(Id campusId)
Gets the
OsidSession associated with the bulk floor
administration service for the given campus. |
RoomBatchAdminSession |
getRoomBatchAdminSession()
Gets the
OsidSession associated with the bulk room
administration service. |
RoomBatchAdminSession |
getRoomBatchAdminSessionForCampus(Id campusId)
Gets the
OsidSession associated with the bulk room
administration service for the given campus. |
changeBranch, initialize, rollbackService
close
supportsBuildingBatchAdmin, supportsCampusBatchAdmin, supportsFloorBatchAdmin, supportsRoomBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
RoomBatchAdminSession getRoomBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk room
administration service. RoomBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRoomBatchAdmin()
is false
optional
- This method must be implemented if
supportsRoomBatchAdmin()
is true.
RoomBatchAdminSession getRoomBatchAdminSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk room
administration service for the given campus.campusId
- the Id
of the Campus
RoomBatchAdminSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRoomBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRoomBatchAdmin()
and
supportsVisibleFederation()
are true
FloorBatchAdminSession getFloorBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk floor
administration service. FloorBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFloorBatchAdmin()
is false
optional
- This method must be implemented if
supportsFloorBatchAdmin()
is true.
FloorBatchAdminSession getFloorBatchAdminSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk floor
administration service for the given campus.campusId
- the Id
of the Campus
FloorBatchAdminSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFloorBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsFloorBatchAdmin()
and
supportsVisibleFederation()
are true
BuildingBatchAdminSession getBuildingBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk building
administration service. BuildingBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBuildingBatchAdmin()
is false
optional
- This method must be implemented if
supportsBuildingBatchAdmin()
is true.
BuildingBatchAdminSession getBuildingBatchAdminSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk building
administration service for the given campus.campusId
- the Id
of the Campus
BuildingBatchAdminSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBuildingBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsBuildingBatchAdmin()
and
supportsVisibleFederation()
are true
CampusBatchAdminSession getCampusBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk campus
administration service. CampusBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCampusBatchAdmin()
is false
optional
- This method must be implemented if
supportsCampusBatchAdmin()
is true.