org.osid.room.batch

Interface RoomBatchProxyManager

All Superinterfaces:

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

public interface RoomBatchProxyManager
extends OsidProxyManager, RoomBatchProfile

The room batch proxy manager provides access to room batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. The sessions included in this manager are:

• RoomBatchAdminSession: a session to manage rooms in bulk
• FloorBatchAdminSession: a session to manage floors in bulk
• BuildingBatchAdminSession: a session to manage 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(Proxy proxy) Gets the OsidSession associated with the bulk building administration service.
BuildingBatchAdminSession	getBuildingBatchAdminSessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the bulk building administration service for the given campus.
CampusBatchAdminSession	getCampusBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk campus administration service.
FloorBatchAdminSession	getFloorBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk room administration service.
FloorBatchAdminSession	getFloorBatchAdminSessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the bulk floor administration service for the given campus.
RoomBatchAdminSession	getRoomBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk room administration service.
RoomBatchAdminSession	getRoomBatchAdminSessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the bulk room administration service for the given campus.

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

Gets the OsidSession associated with the bulk room administration service.

Parameters:

proxy - a proxy

Returns:

a RoomBatchAdminSession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a RoomBatchAdminSession

Throws:

NotFoundException - no Campus found by the given Id

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

Gets the OsidSession associated with the bulk room administration service.

Parameters:

proxy - a proxy

Returns:

a FloorBatchAdminSession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a FloorBatchAdminSession

Throws:

NotFoundException - no Campus found by the given Id

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

Gets the OsidSession associated with the bulk building administration service.

Parameters:

proxy - a proxy

Returns:

a BuildingBatchAdminSession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a BuildingBatchAdminSession

Throws:

NotFoundException - no Campus found by the given Id

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

Gets the OsidSession associated with the bulk campus administration service.

Parameters:

proxy - a proxy

Returns:

a CampusBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCampusBatchAdmin() is false

Compliance:

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