OSID Logo
OSID Specifications
topology batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.batch.EdgeBatchAdminSession
Implementsosid.topology.EdgeAdminSession
Description

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

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

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

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

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

The delete operations delete Edges in bulk. To unmap an Edge from the current Graph, the EdgeGraphAssignmentSession should be used. These delete operations attempt to remove the Edge itself thus removing it from all known Graph catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetEdgeFormsForCreate
Description

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

Parametersosid.topology.batch.EdgePeerListpeersa list of edge peers
osid.type.Type[]edgeRecordTypesarray of edge record types to be included in each create operation or an empty list if none
Returnosid.topology.batch.EdgeBatchFormListthe edge forms
ErrorsNOT_FOUNDa node is not found
NULL_ARGUMENT peers or edgeRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateEdges
Description

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

Parametersosid.topology.batch.EdgeBatchFormListedgeFormsthe edge forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT edgeForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEdgeFormsForUpdate
Description

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

Parametersosid.id.IdListedgeIdsthe Ids of the Edge
Returnosid.topology.batch.EdgeBatchFormListthe edge form
ErrorsNOT_FOUNDan edgeId is not found
NULL_ARGUMENT edgeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateEdges
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 BatchCreateResponse .

Parametersosid.topology.batch.EdgeBatchFormListedgeFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT edgeForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllEdges
Description

Deletes all Edges in this Graph .

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

Deletes edges for the given Ids.

Parametersosid.id.IdListedgeIdsthe Ids of the edges to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT edgeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteEdgesForSourceNode
Description

Deletes edges for the given source node.

Parametersosid.id.IdsourceNodeIdthe Id of a node
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT sourceNodeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteEdgesForDestinationNode
Description

Deletes edges for the given destination node.

Parametersosid.id.IddestinationNodeIdthe Id of a node
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT destinationNodeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveEdgesByDate
Description

Deletes edges 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.
MethodaliasEdges
Description

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