| Interface | osid.topology.batch.EdgeBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.topology.EdgeAdminSession | ||
| Description | 
                 This session creates, updates, and deletes   Create and update operations differ in their usage. To 
                create an   The   Once a batch of   For updates,   Once a batch of   The delete operations delete   | ||
| Method | getEdgeFormsForCreate | ||
| Description | 
                     Gets the edge forms for creating a bunch of new edges. A form is returned for each set of edge peers.  | ||
| Parameters | osid.topology.batch.EdgePeerList | peers | a list of edge peers | 
osid.type.Type[] | edgeRecordTypes | array of edge record types to be included in each create operation or an empty list if none | |
| Return | osid.topology.batch.EdgeBatchFormList | the edge forms | |
| Errors | NOT_FOUND | a node is not found | |
| NULL_ARGUMENT |  peers  or  edgeRecordTypes  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 | createEdges | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.topology.batch.EdgeBatchFormList | edgeForms | the edge forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  edgeForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getEdgeFormsForUpdate | ||
| Description | 
                     Gets the edge forms for updating an existing set of edges. A new edge form should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | edgeIds | the  Ids  of the  Edge   | 
| Return | osid.topology.batch.EdgeBatchFormList | the edge form | |
| Errors | NOT_FOUND | an  edgeId  is not found  |                 |
| NULL_ARGUMENT |  edgeIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateEdges | ||
| Description | 
                     Updates existing edges. This method returns an error if 
                    the entire operation fails. Otherwise, the status of an 
                    individual update operation is indicated in the   | ||
| Parameters | osid.topology.batch.EdgeBatchFormList | edgeForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  edgeForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllEdges | ||
| 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 | deleteEdges | ||
| Description | 
                     Deletes edges for the given   | ||
| Parameters | osid.id.IdList | edgeIds | the  Ids  of the edges to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  edgeIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteEdgesForSourceNode | ||
| Description | 
                     Deletes edges for the given source node.  | ||
| Parameters | osid.id.Id | sourceNodeId | the  Id  of a node  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  sourceNodeId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteEdgesForDestinationNode | ||
| Description | 
                     Deletes edges for the given destination node.  | ||
| Parameters | osid.id.Id | destinationNodeId | the  Id  of a node  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  destinationNodeId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteIneffectiveEdgesByDate | ||
| Description | 
                     Deletes edges 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 | aliasEdges | ||
| 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. | |