org.osid.room.squatting.batch

Interface RoomSquattingBatchManager

All Superinterfaces:

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

public interface RoomSquattingBatchManager
extends OsidManager, RoomSquattingBatchProfile

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

• LeaseBatchAdminSession: a session to create, modify and delete Leases in bulk
• DeedBatchAdminSession: a session to create, modify and delete Deeds in bulk

Method Summary

Methods

Modifier and Type	Method and Description
DeedBatchAdminSession	getDeedBatchAdminSession() Gets the OsidSession associated with the bulk deed administration service.
DeedBatchAdminSession	getDeedBatchAdminSessionForCampus(Id campusId) Gets the OsidSession associated with the bulk deed administration service for the given campus.
LeaseBatchAdminSession	getLeaseBatchAdminSession() Gets the OsidSession associated with the bulk lease administration service.
LeaseBatchAdminSession	getLeaseBatchAdminSessionForCampus(Id campusId) Gets the OsidSession associated with the bulk lease 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.squatting.batch.RoomSquattingBatchProfile

supportsDeedBatchAdmin, supportsLeaseBatchAdmin, 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

getLeaseBatchAdminSession

LeaseBatchAdminSession getLeaseBatchAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk lease administration service.

Returns:

a LeaseBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseBatchAdmin() is false

Compliance:

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

getLeaseBatchAdminSessionForCampus

LeaseBatchAdminSession getLeaseBatchAdminSessionForCampus(Id campusId)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

campusId - the Id of the Campus

Returns:

a LeaseBatchAdminSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getDeedBatchAdminSession

DeedBatchAdminSession getDeedBatchAdminSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk deed administration service.

Returns:

a DeedBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedBatchAdmin() is false

Compliance:

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

getDeedBatchAdminSessionForCampus

DeedBatchAdminSession getDeedBatchAdminSessionForCampus(Id campusId)
                                                        throws NotFoundException,
                                                               OperationFailedException

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

Parameters:

campusId - the Id of the Campus

Returns:

a DeedBatchAdminSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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