Interface | osid.topology.batch.GraphBatchAdminSession | ||
---|---|---|---|
Implements | osid.topology.GraphAdminSession | ||
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 | getGraphFormsForCreate | ||
Description |
Gets the graph forms for creating a bunch of new graph. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | graphRecordTypes | array of graph record types to be included in each create operation or an empty list if none | |
Return | osid.topology.batch.GraphBatchFormList | the graph forms | |
Errors | NULL_ARGUMENT | graphRecordTypes 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 | createGraphs | ||
Description |
Creates a new set of | ||
Parameters | osid.topology.batch.GraphBatchFormList | graphForms | the graph forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | graphForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getGraphFormsForUpdate | ||
Description |
Gets the graph forms for updating an existing set of graphs. A new graph form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | graphIds | the Ids of the Graphs |
Return | osid.topology.batch.GraphBatchFormList | the graph form | |
Errors | NOT_FOUND | a graphId is not found | |
NULL_ARGUMENT | graphIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateGraphs | ||
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 | ||
Parameters | osid.topology.batch.GraphBatchFormList | graphForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | graphForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllGraphs | ||
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 | deleteGraphs | ||
Description |
Deletes graphs for the given | ||
Parameters | osid.id.IdList | graphIds | the Ids of the graphs to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | graphIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasGraphs | ||
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. |