OSID Logo
OSID Specifications
room squatting batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.squatting.batch.LeaseBatchAdminSession
Implementsosid.room.squatting.LeaseAdminSession
Description

This session creates, updates, and deletes Leases in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Lease, a LeaseForm is requested using getLeaseFormsForCreate() specifying the desired peers and record Types or none if no record Types are needed. Each of the returned LeaseForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a LeaseForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each LeaseForm corresponds to an attempted transaction.

The LeaseForms returned from getLeaseFormsForCreate() may be linked to the originating request through the peer Ids of the LeaseForm. In the case where there may be duplicates, any LeaseForm of the same peer Ids may be used for a create operation.

Once a batch of LeaseForms are submitted for create, a CreateResponse is returned for each LeaseForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createLeases(), errors specific to an individual LeaseForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating LeaseForm through the LeaseForm Id .

For updates, LeaseForms are requested to the Lease Id that is to be updated using getLeaseFormsForUpdate() where the reference Id in the LeaseForm may be used to link the request. Similarly, the LeaseForm has metadata about the data that can be updated and it can perform validation before submitting the update. The LeaseForm can only be used once for a successful update and cannot be reused.

Once a batch of LeaseForms are submitted for update, an UpdateResponse is returned for each LeaseForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateLeases(), errors specific to an individual LeaseForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating LeaseForm through the LeaseForm Id.

The delete operations delete Leases in bulk. To unmap a Lease from the current Campus, the LeaseCampusAssignmentSession should be used. These delete operations attempt to remove the Lease itself thus removing it from all known Campus catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetLeaseFormsForCreate
Description

Gets the lease forms for creating a bunch of new leases. A lease form is returned for each supplied peer.

Parametersosid.room.squatting.batch.LeasePeerListpeersa list of lease peers
osid.type.Type[]leaseRecordTypesarray of lease record types to be included in each create operation or an empty list if none
Returnosid.room.squatting.batch.LeaseBatchFormListthe lease forms
ErrorsNOT_FOUNDa roomId or resourceId is not found
NULL_ARGUMENT peers or leaseRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateLeases
Description

Creates a new set of Leases. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.room.squatting.batch.LeaseBatchFormListleaseFormsthe lease forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT leaseForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLeaseFormsForUpdate
Description

Gets the lease forms for updating an existing set of leases. A new lease form should be requested for each update transaction.

Parametersosid.id.IdListleaseIdsthe Ids of the Lease
Returnosid.room.squatting.batch.LeaseBatchFormListthe lease form
ErrorsNOT_FOUNDa leaseId is not found
NULL_ARGUMENT leaseIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateLeases
Description

Updates existing leases. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.room.squatting.batch.LeaseBatchFormListleaseFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT leaseForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllLeases
Description

Deletes all Leases in this Campus .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteLeases
Description

Deletes leases for the given Ids.

Parametersosid.id.IdListleaseIdsthe Ids of the leases to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT leaseIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteLeasesForRoom
Description

Deletes leases for the given room.

Parametersosid.id.IdroomIdthe Id of a room
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT roomId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteLeasesForTenant
Description

Deletes leases for the given tenant.

Parametersosid.id.IdresourceIdthe Id of a resource
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveLeasesByDate
Description

Deletes leases expired before the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasLeases
Description

Adds an Id to a Lease for the purpose of creating compatibility. The primary Id of the Lease is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another lease, it is reassigned to the given entry Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.