OSID Logo
OSID Specifications
topology batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.batch.GraphBatchAdminSession
Implementsosid.topology.GraphAdminSession
Description

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

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

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

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

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

The delete operations delete Graphs in bulk. Bulk delete operations return the results in DeleteResponses.

MethodgetGraphFormsForCreate
Description

Gets the graph forms for creating a bunch of new graph.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]graphRecordTypesarray of graph record types to be included in each create operation or an empty list if none
Returnosid.topology.batch.GraphBatchFormListthe graph forms
ErrorsNULL_ARGUMENT graphRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateGraphs
Description

Creates a new set of Graphs. 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.GraphBatchFormListgraphFormsthe graph forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT graphForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGraphFormsForUpdate
Description

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

Parametersosid.id.IdListgraphIdsthe Ids of the Graphs
Returnosid.topology.batch.GraphBatchFormListthe graph form
ErrorsNOT_FOUNDa graphId is not found
NULL_ARGUMENT graphIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateGraphs
Description

Updates existing graphs. 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.GraphBatchFormListgraphFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT graphForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllGraphs
Description

Deletes all Graphs.

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

Deletes graphs for the given Ids.

Parametersosid.id.IdListgraphIdsthe Ids of the graphs to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT graphIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasGraphs
Description

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