| Interface | osid.room.squatting.batch.DeedBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.room.squatting.DeedAdminSession | ||
| 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 | getDeedFormsForCreate | ||
| Description | 
                     Gets the deed forms for creating a bunch of new deeds. A deed form is returned for each supplied peer.  | ||
| Parameters | osid.room.squatting.batch.DeedPeerList | peers | a list of building  Ids   | 
osid.type.Type[] | deedRecordTypes | array of deed record types to be included in each create operation or an empty list if none | |
| Return | osid.room.squatting.batch.DeedBatchFormList | the deed forms | |
| Errors | NOT_FOUND | a  buildingId  or  resourceId  is not found  |                 |
| NULL_ARGUMENT |  peers  or  deedRecordTypes  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 | createDeeds | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.room.squatting.batch.DeedBatchFormList | deedForms | the deed forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  deedForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getDeedFormsForUpdate | ||
| Description | 
                     Gets the deed forms for updating an existing set of deeds. A new deed form should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | deedIds | the  Ids  of the  Deed   | 
| Return | osid.room.squatting.batch.DeedBatchFormList | the deed form | |
| Errors | NOT_FOUND | a  deedId  is not found  |                 |
| NULL_ARGUMENT |  deedIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateDeeds | ||
| Description | 
                     Updates existing deeds. 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.DeedBatchFormList | deedForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  deedForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllDeeds | ||
| 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 | deleteDeeds | ||
| Description | 
                     Deletes deeds for the given   | ||
| Parameters | osid.id.IdList | deedIds | the  Ids  of the deeds to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  deedIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteDeedsForBuilding | ||
| Description | 
                     Deletes all deeds for a building.  | ||
| Parameters | osid.id.Id | buildingId | a building  Id   | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  buildingId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteDeedsForOwner | ||
| Description | 
                     Deletes all deeds for an owner.  | ||
| Parameters | osid.id.Id | resourceId | a resource  Id   | 
| 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 | deleteIneffectiveDeedsByDate | ||
| Description | 
                     Deletes deeds 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 | aliasDeeds | ||
| 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. | |