public interface GraphBatchAdminSession extends GraphAdminSession
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.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasGraphs(AliasRequestList aliasRequests)
Adds an
Id to a Graph for the purpose of
creating compatibility. |
CreateResponseList |
createGraphs(GraphBatchFormList graphForms)
Creates a new set of
Graphs. |
DeleteResponseList |
deleteAllGraphs()
Deletes all
Graphs. |
DeleteResponseList |
deleteGraphs(IdList graphIds)
Deletes graphs for the given
Ids. |
GraphBatchFormList |
getGraphFormsForCreate(long number,
Type[] graphRecordTypes)
Gets the graph forms for creating a bunch of new graph.
|
GraphBatchFormList |
getGraphFormsForUpdate(IdList graphIds)
Gets the graph forms for updating an existing set of graphs.
|
UpdateResponseList |
updateGraphs(GraphBatchFormList graphForms)
Updates existing graphs.
|
aliasGraph, canCreateGraphs, canCreateGraphWithRecordTypes, canDeleteGraphs, canManageGraphAliases, canUpdateGraphs, createGraph, deleteGraph, getGraphFormForCreate, getGraphFormForUpdate, updateGraph
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
GraphBatchFormList getGraphFormsForCreate(long number, Type[] graphRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievegraphRecordTypes
- array of graph record types to be included in
each create operation or an empty list if noneNullArgumentException
- graphRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createGraphs(GraphBatchFormList graphForms) throws OperationFailedException, PermissionDeniedException
Graphs.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.graphForms
- the graph formsNullArgumentException
- graphForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GraphBatchFormList getGraphFormsForUpdate(IdList graphIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
graphIds
- the Ids
of the Graphs
NotFoundException
- a graphId
is not
foundNullArgumentException
- graphIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateGraphs(GraphBatchFormList graphForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.graphForms
- the form containing the elements to be updatedNullArgumentException
- graphForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllGraphs() throws OperationFailedException, PermissionDeniedException
Graphs.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteGraphs(IdList graphIds) throws OperationFailedException, PermissionDeniedException
Ids.
graphIds
- the Ids
of the graphs to deleteNullArgumentException
- graphIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasGraphs(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.