Interface | osid.relationship.batch.RelationshipBatchAdminSession | ||
---|---|---|---|
Implements | osid.relationship.RelationshipAdminSession | ||
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 | getRelationshipFormsForCreate | ||
Description |
Gets the relationship forms for creating a bunch of new relationships. A form is returned for each set of relationship peers. | ||
Parameters | osid.relationship.batch.RelationshipPeerList | peers | a list of relationship peers |
osid.type.Type[] | relationshipRecordTypes | array of relationship record types to be included in each create operation or an empty list if none | |
Return | osid.relationship.batch.RelationshipBatchFormList | the relationship forms | |
Errors | NOT_FOUND | a node is not found | |
NULL_ARGUMENT | peers or relationshipRecordTypes 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 | createRelationships | ||
Description |
Creates a new set of | ||
Parameters | osid.relationship.batch.RelationshipBatchFormList | relationshipForms | the relationship forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | relationshipForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRelationshipFormsForUpdate | ||
Description |
Gets the relationship forms for updating an existing set of relationships. A new relationship form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | relationshipIds | the Ids of the Relationship |
Return | osid.relationship.batch.RelationshipBatchFormList | the relationship form | |
Errors | NOT_FOUND | a relationshipId is not found | |
NULL_ARGUMENT | relationshipIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateRelationships | ||
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
| ||
Parameters | osid.relationship.batch.RelationshipBatchFormList | relationshipForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | relationshipForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllRelationships | ||
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 | deleteRelationships | ||
Description |
Deletes relationships for the given | ||
Parameters | osid.id.IdList | relationshipIds | the Ids of the relationships to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | relationshipIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteRelationshipsForSourceId | ||
Description |
Deletes relationships for the given source. | ||
Parameters | osid.id.Id | sourceId | the Id of a peer |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | sourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteRelationshipsForDestinationId | ||
Description |
Deletes relationships for the given destination node. | ||
Parameters | osid.id.Id | destinationId | the Id of a peer |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | destinationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveRelationshipsByDate | ||
Description |
Deletes relationships ineffective 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 | aliasRelationships | ||
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. |