Interface RoomSquattingBatchProxyManager
- All Superinterfaces:
AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, RoomSquattingBatchProfile, Sourceable
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
-
Method Summary
Modifier and TypeMethodDescriptiongetDeedBatchAdminSession(Proxy proxy) Gets theOsidSessionassociated with the bulk deed administration service.getDeedBatchAdminSessionForCampus(Id campusId, Proxy proxy) Gets theOsidSessionassociated with the bulk deed administration service for the given campus.getLeaseBatchAdminSession(Proxy proxy) Gets theOsidSessionassociated with the bulk room administration service.getLeaseBatchAdminSessionForCampus(Id campusId, Proxy proxy) Gets theOsidSessionassociated with the bulk lease administration service for the given campus.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface OsidProxyManager
closeMethods inherited from interface OsidProxyManager
changeBranch, initialize, rollbackServiceModifier and TypeMethodDescriptionvoidchangeBranch(Id branchId, Proxy proxy) Changes the service branch.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.rollbackService(Date rollbackTime, Proxy proxy) Rolls back this service to a point in time.Methods inherited from interface RoomSquattingBatchProfile
supportsDeedBatchAdmin, supportsLeaseBatchAdmin, supportsVisibleFederationModifier and TypeMethodDescriptionbooleanTests if bulk administration of deeds is available.booleanTests if bulk administration of leases is available.booleanTests if federation is visible.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
getLeaseBatchAdminSession
Gets theOsidSessionassociated with the bulk room administration service.- Parameters:
proxy- a proxy- Returns:
- a
LeaseBatchAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsLeaseBatchAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsLeaseBatchAdmin()} is {@code true} .
-
getLeaseBatchAdminSessionForCampus
LeaseBatchAdminSession getLeaseBatchAdminSessionForCampus(Id campusId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the bulk lease administration service for the given campus.- Parameters:
campusId- theIdof theCampusproxy- a proxy- Returns:
- a
LeaseBatchAdminSession - Throws:
NotFoundException- noCampusfound by the givenIdNullArgumentException-campusIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsLeaseBatchAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsLeaseBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getDeedBatchAdminSession
Gets theOsidSessionassociated with the bulk deed administration service.- Parameters:
proxy- a proxy- Returns:
- a
DeedBatchAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDeedBatchAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDeedBatchAdmin()} is {@code true} .
-
getDeedBatchAdminSessionForCampus
DeedBatchAdminSession getDeedBatchAdminSessionForCampus(Id campusId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the bulk deed administration service for the given campus.- Parameters:
campusId- theIdof theCampusproxy- a proxy- Returns:
- a
DeedBatchAdminSession - Throws:
NotFoundException- noCampusfound by the givenIdNullArgumentException-campusIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDeedBatchAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDeedBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-