org.osid.room.batch

Interface RoomBatchManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, RoomBatchProfile, Sourceable

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

Method Summary

Methods

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.

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.batch.RoomBatchProfile

supportsBuildingBatchAdmin, supportsCampusBatchAdmin, supportsFloorBatchAdmin, supportsRoomBatchAdmin, 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

getRoomBatchAdminSession

RoomBatchAdminSession getRoomBatchAdminSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk room administration service.

Returns:

a RoomBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomBatchAdmin() is false

Compliance:

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

getRoomBatchAdminSessionForCampus

RoomBatchAdminSession getRoomBatchAdminSessionForCampus(Id campusId)
                                                        throws NotFoundException,
                                                               OperationFailedException

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

Parameters:

campusId - the Id of the Campus

Returns:

a RoomBatchAdminSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRoomBatchAdmin() and supportsVisibleFederation() are true

getFloorBatchAdminSession

FloorBatchAdminSession getFloorBatchAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk floor administration service.

Returns:

a FloorBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFloorBatchAdmin() is false

Compliance:

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

getFloorBatchAdminSessionForCampus

FloorBatchAdminSession getFloorBatchAdminSessionForCampus(Id campusId)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

campusId - the Id of the Campus

Returns:

a FloorBatchAdminSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFloorBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsFloorBatchAdmin() and supportsVisibleFederation() are true

getBuildingBatchAdminSession

BuildingBatchAdminSession getBuildingBatchAdminSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the bulk building administration service.

Returns:

a BuildingBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBuildingBatchAdmin() is false

Compliance:

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

getBuildingBatchAdminSessionForCampus

BuildingBatchAdminSession getBuildingBatchAdminSessionForCampus(Id campusId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

campusId - the Id of the Campus

Returns:

a BuildingBatchAdminSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBuildingBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsBuildingBatchAdmin() and supportsVisibleFederation() are true

getCampusBatchAdminSession

CampusBatchAdminSession getCampusBatchAdminSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk campus administration service.

Returns:

a CampusBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCampusBatchAdmin() is false

Compliance:

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