Interface RoomBatchProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidProfile, OsidProxyManager, 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 . 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface RoomBatchProfile

supportsBuildingBatchAdmin, supportsCampusBatchAdmin, supportsFloorBatchAdmin, supportsRoomBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsBuildingBatchAdmin()	Tests if bulk administration of buildings is available.
boolean	supportsCampusBatchAdmin()	Tests if bulk administration of campuses is available.
boolean	supportsFloorBatchAdmin()	Tests if bulk administration of floors is available.
boolean	supportsRoomBatchAdmin()	Tests if bulk administration of rooms is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsRoomBatchAdmin()} is {@code 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 {@code supportsRoomBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsFloorBatchAdmin()} is {@code 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 {@code supportsFloorBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsBuildingBatchAdmin()} is {@code 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 {@code supportsBuildingBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCampusBatchAdmin()} is {@code true} .