org.osid.room.construction.batch

Interface RoomConstructionBatchProxyManager

All Superinterfaces:

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

public interface RoomConstructionBatchProxyManager
extends OsidProxyManager, RoomConstructionBatchProfile

The room batch proxy manager provides access to room batch construction 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:

• RenovationBatchAdminSession: a session to manage renovations in bulk
• ProjectBatchAdminSession: a session to manage projects in bulk

Method Summary

Methods

Modifier and Type	Method and Description
ProjectBatchAdminSession	getProjectBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk project administration service.
ProjectBatchAdminSession	getProjectBatchAdminSessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the bulk project administration service for the given campus.
RenovationBatchAdminSession	getRenovationBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk room administration service.
RenovationBatchAdminSession	getRenovationBatchAdminSessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the bulk renovation 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.construction.batch.RoomConstructionBatchProfile

supportsProjectBatchAdmin, supportsRenovationBatchAdmin, 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

getRenovationBatchAdminSession

RenovationBatchAdminSession getRenovationBatchAdminSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the bulk room administration service.

Parameters:

proxy - a proxy

Returns:

a RenovationBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRenovationBatchAdmin() is false

Compliance:

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

getRenovationBatchAdminSessionForCampus

RenovationBatchAdminSession getRenovationBatchAdminSessionForCampus(Id campusId,
                                                                  Proxy proxy)
                                                                    throws NotFoundException,
                                                                           OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a RenovationBatchAdminSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRenovationBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getProjectBatchAdminSession

ProjectBatchAdminSession getProjectBatchAdminSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk project administration service.

Parameters:

proxy - a proxy

Returns:

a ProjectBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProjectBatchAdmin() is false

Compliance:

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

getProjectBatchAdminSessionForCampus

ProjectBatchAdminSession getProjectBatchAdminSessionForCampus(Id campusId,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a ProjectBatchAdminSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProjectBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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