OSID Logo
OSID Specifications
relationship batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.batch.RelationshipBatchAdminSession
Implementsosid.relationship.RelationshipAdminSession
Description

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

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

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

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

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

The delete operations delete Relationships in bulk. To unmap a Relationship from the current Family, the RelationshipFamilyAssignmentSession should be used. These delete operations attempt to remove the Relationship itself thus removing it from all known Family catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetRelationshipFormsForCreate
Description

Gets the relationship forms for creating a bunch of new relationships. A form is returned for each set of relationship peers.

Parametersosid.relationship.batch.RelationshipPeerListpeersa list of relationship peers
osid.type.Type[]relationshipRecordTypesarray of relationship record types to be included in each create operation or an empty list if none
Returnosid.relationship.batch.RelationshipBatchFormListthe relationship forms
ErrorsNOT_FOUNDa node is not found
NULL_ARGUMENT peers or relationshipRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateRelationships
Description

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

Parametersosid.relationship.batch.RelationshipBatchFormListrelationshipFormsthe relationship forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT relationshipForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRelationshipFormsForUpdate
Description

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

Parametersosid.id.IdListrelationshipIdsthe Ids of the Relationship
Returnosid.relationship.batch.RelationshipBatchFormListthe relationship form
ErrorsNOT_FOUNDa relationshipId is not found
NULL_ARGUMENT relationshipIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateRelationships
Description

Updates existing 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.relationship.batch.RelationshipBatchFormListrelationshipFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT relationshipForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllRelationships
Description

Deletes all Relationships in this Family .

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

Deletes relationships for the given Ids.

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

Deletes relationships for the given source.

Parametersosid.id.IdsourceIdthe Id of a peer
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT sourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteRelationshipsForDestinationId
Description

Deletes relationships for the given destination node.

Parametersosid.id.IddestinationIdthe Id of a peer
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT destinationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveRelationshipsByDate
Description

Deletes relationships ineffective 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.
MethodaliasRelationships
Description

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