OSID Logo
OSID Specifications
resource batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.batch.ResourceRelationshipBatchAdminSession
Implementsosid.resource.ResourceRelationshipAdminSession
Description

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

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

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

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

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

The delete operations delete ResourceRelationships in bulk. To unmap a ResourceRelationship from the current Bin, the ResourceRelationshipBinAssignmentSession should be used. These delete operations attempt to remove the ResourceRelationship itself thus removing it from all known Bin catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetResourceRelationshipFormsForCreate
Description

Gets the resource relationship forms for creating a bunch of new resource relationships. A ResourceRelationshipForm is returned for each resource peer.

Parametersosid.resource.batch.ResourceRelationshipPeerListpeersa list of peers
osid.type.Type[]resourceRelationshipRecordTypesarray of resource relationship record types to be included in each create operation or an empty list if none
Returnosid.resource.batch.ResourceRelationshipBatchFormListthe resource relationship forms
ErrorsNOT_FOUNDa resourceId is not found
NULL_ARGUMENT peers or resourceRelationshipRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateResourceRelationships
Description

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

Parametersosid.resource.batch.ResourceRelationshipBatchFormListresourceRelationshipFormsthe resource relationship forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT resourceRelationshipForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetResourceRelationshipFormsForUpdate
Description

Gets the resource relationship forms for updating an existing set of resource relationships. A new resource relationship form should be requested for each update transaction.

Parametersosid.id.IdListresourceRelationshipIdsthe Ids of the ResourceRelationship
Returnosid.resource.batch.ResourceRelationshipBatchFormListthe resource relationship form
ErrorsNOT_FOUNDa resourceRelationshipId is not found
NULL_ARGUMENT resourceRelationshipIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateResourceRelationships
Description

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

Parametersosid.resource.batch.ResourceRelationshipBatchFormListresourceRelationshipFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT resourceRelationshipForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllResourceRelationships
Description

Deletes all ResourceRelationships in this Bin .

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

Deletes resource relationships for the given Ids.

Parametersosid.id.IdListresourceRelationshipIdsthe Ids of the resource relationships to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceRelationshipIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteResourceRelationshipsForSourceRelationship
Description

Deletes all resource relationships for the given resource.

Parametersosid.id.IdresourceIdan 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.
MethoddeleteResourceRelationshipsForDestinationRelationship
Description

Deletes all resource relationships for the given resource.

Parametersosid.id.IdresourceIdan 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.
MethoddeleteIneffectiveResourceRelationshipsByDate
Description

Deletes resource relationships 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.
MethodaliasResourceRelationships
Description

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