org.osid.room.construction.batch

Interface RoomConstructionBatchManager

All Superinterfaces:

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

public interface RoomConstructionBatchManager
extends OsidManager, RoomConstructionBatchProfile

The room construction batch manager provides access to room batch construction sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• RenovationBatchAdminSession: a session to create, modify and delete Renovations in bulk
• ProjectBatchAdminSession: a session to create, modify and delete Projects in bulk

Method Summary

Methods

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

Gets the OsidSession associated with the bulk renovation administration service.

Returns:

a RenovationBatchAdminSession

Throws:

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

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

Parameters:

campusId - the Id of the Campus

Returns:

a RenovationBatchAdminSession

Throws:

NotFoundException - no Campus found by the given Id

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

Gets the OsidSession associated with the bulk project administration service.

Returns:

a ProjectBatchAdminSession

Throws:

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

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

Parameters:

campusId - the Id of the Campus

Returns:

a ProjectBatchAdminSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId 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