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

This session creates, updates, and deletes Deeds 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 Deed, a DeedForm is requested using getDeedFormsForCreate() specifying the peers and desired record Types or none if no record Types are needed. Each of the returned DeedForms 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 DeedForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each DeedForm corresponds to an attempted transaction.

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

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

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

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

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

MethodgetDeedFormsForCreate
Description

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

Parametersosid.room.squatting.batch.DeedPeerListpeersa list of building Ids
osid.type.Type[]deedRecordTypesarray of deed record types to be included in each create operation or an empty list if none
Returnosid.room.squatting.batch.DeedBatchFormListthe deed forms
ErrorsNOT_FOUNDa buildingId or resourceId is not found
NULL_ARGUMENT peers or deedRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateDeeds
Description

Creates a new set of Deeds. 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.DeedBatchFormListdeedFormsthe deed forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT deedForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDeedFormsForUpdate
Description

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

Parametersosid.id.IdListdeedIdsthe Ids of the Deed
Returnosid.room.squatting.batch.DeedBatchFormListthe deed form
ErrorsNOT_FOUNDa deedId is not found
NULL_ARGUMENT deedIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateDeeds
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 BatchCreateResponse .

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

Deletes all Deeds in this Campus .

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

Deletes deeds for the given Ids.

Parametersosid.id.IdListdeedIdsthe Ids of the deeds to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT deedIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteDeedsForBuilding
Description

Deletes all deeds for a building.

Parametersosid.id.IdbuildingIda building Id
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT buildingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteDeedsForOwner
Description

Deletes all deeds for an owner.

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

Deletes deeds 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.
MethodaliasDeeds
Description

Adds an Id to a Deed for the purpose of creating compatibility. The primary Id of the Deed is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another deed, 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.