| Interface | osid.resource.batch.ResourceRelationshipBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.resource.ResourceRelationshipAdminSession | ||
| 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 | getResourceRelationshipFormsForCreate | ||
| Description | 
                     Gets the resource relationship forms for creating a 
                    bunch of new resource relationships. A   | ||
| Parameters | osid.resource.batch.ResourceRelationshipPeerList | peers | a list of peers | 
osid.type.Type[] | resourceRelationshipRecordTypes | array of resource relationship record types to be included in each create operation or an empty list if none | |
| Return | osid.resource.batch.ResourceRelationshipBatchFormList | the resource relationship forms | |
| Errors | NOT_FOUND | a  resourceId  is not found  |                 |
| NULL_ARGUMENT |  peers  or  resourceRelationshipRecordTypes  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 | createResourceRelationships | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.resource.batch.ResourceRelationshipBatchFormList | resourceRelationshipForms | the resource relationship forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  resourceRelationshipForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceRelationshipFormsForUpdate | ||
| 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.  | ||
| Parameters | osid.id.IdList | resourceRelationshipIds | the  Ids  of the  ResourceRelationship   | 
| Return | osid.resource.batch.ResourceRelationshipBatchFormList | the resource relationship form | |
| Errors | NOT_FOUND | a  resourceRelationshipId  is not found  |                 |
| NULL_ARGUMENT |  resourceRelationshipIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateResourceRelationships | ||
| 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   | ||
| Parameters | osid.resource.batch.ResourceRelationshipBatchFormList | resourceRelationshipForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  resourceRelationshipForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllResourceRelationships | ||
| 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 | deleteResourceRelationships | ||
| Description | 
                     Deletes resource relationships for the given   | ||
| Parameters | osid.id.IdList | resourceRelationshipIds | the  Ids  of the resource relationships to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  resourceRelationshipIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteResourceRelationshipsForSourceRelationship | ||
| Description | 
                     Deletes all resource relationships for the given resource.  | ||
| Parameters | osid.id.Id | resourceId | an  Id  of a resource  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  resourceId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteResourceRelationshipsForDestinationRelationship | ||
| Description | 
                     Deletes all resource relationships for the given resource.  | ||
| Parameters | osid.id.Id | resourceId | an  Id  of a resource  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  resourceId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteIneffectiveResourceRelationshipsByDate | ||
| Description | 
                     Deletes resource relationships expired 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 | aliasResourceRelationships | ||
| 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. | |