Interface RoomSquattingBatchProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, RoomSquattingBatchProfile, Sourceable

public interface RoomSquattingBatchProxyManager
extends OsidProxyManager, RoomSquattingBatchProfile

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

• LeaseBatchAdminSession: a session to manage leases in bulk
• DeedBatchAdminSession: a session to manage deeds in bulk

RoomSquattingBatchProxyManager may be accessed by multiple processing threads.

Method Summary

Modifier and Type	Method	Description
DeedBatchAdminSession	getDeedBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk deed administration service.
DeedBatchAdminSession	getDeedBatchAdminSessionForCampus(Id campusId, Proxy proxy)	Gets the OsidSession associated with the bulk deed administration service for the given campus.
LeaseBatchAdminSession	getLeaseBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk room administration service.
LeaseBatchAdminSession	getLeaseBatchAdminSessionForCampus(Id campusId, Proxy proxy)	Gets the OsidSession associated with the bulk lease administration service for the given campus.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidProfile

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

Methods inherited from interface OsidProxyManager

close

Methods inherited from interface OsidProxyManager

changeBranch, getProxy, getProxyCondition, initialize, rollbackService

Methods inherited from interface RoomSquattingBatchProfile

supportsDeedBatchAdmin, supportsLeaseBatchAdmin, supportsVisibleFederation

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Details

getLeaseBatchAdminSession

LeaseBatchAdminSession getLeaseBatchAdminSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the bulk room administration service.

Parameters:

proxy - a proxy

Returns:

a LeaseBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsLeaseBatchAdmin()} is {@code true}.

getLeaseBatchAdminSessionForCampus

LeaseBatchAdminSession getLeaseBatchAdminSessionForCampus(Id campusId,
 Proxy proxy)
                                                   throws NotFoundException,
OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a LeaseBatchAdminSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLeaseBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getDeedBatchAdminSession

DeedBatchAdminSession getDeedBatchAdminSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the bulk deed administration service.

Parameters:

proxy - a proxy

Returns:

a DeedBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsDeedBatchAdmin()} is {@code true}.

getDeedBatchAdminSessionForCampus

DeedBatchAdminSession getDeedBatchAdminSessionForCampus(Id campusId,
 Proxy proxy)
                                                 throws NotFoundException,
OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a DeedBatchAdminSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDeedBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}