OSID Logo
OSID Specifications
room squatting batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.squatting.batch.RoomSquattingBatchManager
Implementsosid.OsidManager
osid.room.squatting.batch.RoomSquattingBatchProfile
Description

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
MethodgetLeaseBatchAdminSession
Description

Gets the OsidSession associated with the bulk lease administration service.

Returnosid.room.squatting.batch.LeaseBatchAdminSessiona LeaseBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLeaseBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsLeaseBatchAdmin() is true.
MethodgetLeaseBatchAdminSessionForCampus
Description

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

Parametersosid.id.IdcampusIdthe Id of the Campus
Returnosid.room.squatting.batch.LeaseBatchAdminSessiona LeaseBatchAdminSession
ErrorsNOT_FOUNDno Campus found by the given Id
NULL_ARGUMENT campusId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLeaseBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsLeaseBatchAdmin() and supportsVisibleFederation() are true
MethodgetDeedBatchAdminSession
Description

Gets the OsidSession associated with the bulk deed administration service.

Returnosid.room.squatting.batch.DeedBatchAdminSessiona DeedBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeedBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsDeedBatchAdmin() is true.
MethodgetDeedBatchAdminSessionForCampus
Description

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

Parametersosid.id.IdcampusIdthe Id of the Campus
Returnosid.room.squatting.batch.DeedBatchAdminSessiona DeedBatchAdminSession
ErrorsNOT_FOUNDno Campus found by the given Id
NULL_ARGUMENT campusId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeedBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDeedBatchAdmin() and supportsVisibleFederation() are true