Interface | osid.room.squatting.batch.LeaseBatchAdminSession | ||
---|---|---|---|
Implements | osid.room.squatting.LeaseAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getLeaseFormsForCreate | ||
Description |
Gets the lease forms for creating a bunch of new leases. A lease form is returned for each supplied peer. | ||
Parameters | osid.room.squatting.batch.LeasePeerList | peers | a list of lease peers |
osid.type.Type[] | leaseRecordTypes | array of lease record types to be included in each create operation or an empty list if none | |
Return | osid.room.squatting.batch.LeaseBatchFormList | the lease forms | |
Errors | NOT_FOUND | a roomId or resourceId is not found | |
NULL_ARGUMENT | peers or leaseRecordTypes is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createLeases | ||
Description |
Creates a new set of | ||
Parameters | osid.room.squatting.batch.LeaseBatchFormList | leaseForms | the lease forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | leaseForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLeaseFormsForUpdate | ||
Description |
Gets the lease forms for updating an existing set of leases. A new lease form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | leaseIds | the Ids of the Lease |
Return | osid.room.squatting.batch.LeaseBatchFormList | the lease form | |
Errors | NOT_FOUND | a leaseId is not found | |
NULL_ARGUMENT | leaseIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateLeases | ||
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 | ||
Parameters | osid.room.squatting.batch.LeaseBatchFormList | leaseForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | leaseForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllLeases | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteLeases | ||
Description |
Deletes leases for the given | ||
Parameters | osid.id.IdList | leaseIds | the Ids of the leases to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | leaseIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteLeasesForRoom | ||
Description |
Deletes leases for the given room. | ||
Parameters | osid.id.Id | roomId | the Id of a room |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | roomId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteLeasesForTenant | ||
Description |
Deletes leases for the given tenant. | ||
Parameters | osid.id.Id | resourceId | the Id of a resource |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveLeasesByDate | ||
Description |
Deletes leases expired before the given date. | ||
Parameters | osid.calendaring.DateTime | date | a date |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasLeases | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |