org.osid.relationship.batch

Interface RelationshipBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, RelationshipAdminSession

public interface RelationshipBatchAdminSession
extends RelationshipAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasRelationships(AliasRequestList aliasRequests) Adds an Id to a Relationship for the purpose of creating compatibility.
CreateResponseList	createRelationships(RelationshipBatchFormList relationshipForms) Creates a new set of Relationships.
DeleteResponseList	deleteAllRelationships() Deletes all Relationships in this Family .
DeleteResponseList	deleteIneffectiveRelationshipsByDate(DateTime date) Deletes relationships ineffective before the given date.
DeleteResponseList	deleteRelationships(IdList relationshipIds) Deletes relationships for the given Ids.
DeleteResponseList	deleteRelationshipsForDestinationId(Id destinationId) Deletes relationships for the given destination node.
DeleteResponseList	deleteRelationshipsForSourceId(Id sourceId) Deletes relationships for the given source.
RelationshipBatchFormList	getRelationshipFormsForCreate(RelationshipPeerList peers, Type[] relationshipRecordTypes) Gets the relationship forms for creating a bunch of new relationships.
RelationshipBatchFormList	getRelationshipFormsForUpdate(IdList relationshipIds) Gets the relationship forms for updating an existing set of relationships.
UpdateResponseList	updateRelationships(RelationshipBatchFormList relationshipForms) Updates existing relationships.

Methods inherited from interface org.osid.relationship.RelationshipAdminSession

aliasRelationship, canCreateRelationships, canCreateRelationshipWithRecordTypes, canDeleteRelationships, canManageRelationshipAliases, canUpdateRelationships, createRelationship, deleteRelationship, getFamily, getFamilyId, getRelationshipFormForCreate, getRelationshipFormForUpdate, updateRelationship

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getRelationshipFormsForCreate

RelationshipBatchFormList getRelationshipFormsForCreate(RelationshipPeerList peers,
                                                      Type[] relationshipRecordTypes)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

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

Parameters:

peers - a list of relationship peers

relationshipRecordTypes - array of relationship record types to be included in each create operation or an empty list if none

Returns:

the relationship forms

Throws:

NotFoundException - a node is not found

NullArgumentException - peers or relationshipRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createRelationships

CreateResponseList createRelationships(RelationshipBatchFormList relationshipForms)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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 .

Parameters:

relationshipForms - the relationship forms

Returns:

the create responses

Throws:

NullArgumentException - relationshipForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRelationshipFormsForUpdate

RelationshipBatchFormList getRelationshipFormsForUpdate(IdList relationshipIds)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

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

Parameters:

relationshipIds - the Ids of the Relationship

Returns:

the relationship form

Throws:

NotFoundException - a relationshipId is not found

NullArgumentException - relationshipIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateRelationships

UpdateResponseList updateRelationships(RelationshipBatchFormList relationshipForms)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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 .

Parameters:

relationshipForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - relationshipForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllRelationships

DeleteResponseList deleteAllRelationships()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Deletes all Relationships in this Family .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteRelationships

DeleteResponseList deleteRelationships(IdList relationshipIds)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes relationships for the given Ids.

Parameters:

relationshipIds - the Ids of the relationships to delete

Returns:

the delete responses

Throws:

NullArgumentException - relationshipIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteRelationshipsForSourceId

DeleteResponseList deleteRelationshipsForSourceId(Id sourceId)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Deletes relationships for the given source.

Parameters:

sourceId - the Id of a peer

Returns:

the delete responses

Throws:

NullArgumentException - sourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteRelationshipsForDestinationId

DeleteResponseList deleteRelationshipsForDestinationId(Id destinationId)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

Deletes relationships for the given destination node.

Parameters:

destinationId - the Id of a peer

Returns:

the delete responses

Throws:

NullArgumentException - destinationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveRelationshipsByDate

DeleteResponseList deleteIneffectiveRelationshipsByDate(DateTime date)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Deletes relationships ineffective before the given date.

Parameters:

date - a date

Returns:

the delete responses

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasRelationships

AliasResponseList aliasRelationships(AliasRequestList aliasRequests)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.