OSID - osid.topology.GraphAdminSession Service Interface Definition

Interface	osid.topology.GraphAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Graphs.` 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 `getGraphFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `GraphForm` 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 the `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. For updates, `GraphForms` are requested to the `Graph` `Id` that is to be updated using `getGraphFormForUpdate().` 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. The delete operations delete `Graphs.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateGraphs
Description	Tests if this user can create `Graphs.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Graph.` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `Graph` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateGraphWithRecordTypes
Description	Tests if this user can create a single `Graph` using the desired record types. While `TopologyManager.getGraphRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Graph.` Providing an empty array tests if a `Graph` can be created with no records.
Parameters	`osid.type.Type[]`	`graphRecordTypes`	array of graph record types
Return	`boolean`		`true` if `Graph` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`graphRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getGraphFormForCreate
Description	Gets the graph form for creating new graphs. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`graphRecordTypes`	array of graph record types
Return	`osid.topology.GraphForm`		the graph form
Errors	NULL_ARGUMENT		`graphRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createGraph
Description	Creates a new `Graph.`
Parameters	`osid.topology.GraphForm`	`graphForm`	the form for this `Graph`
Return	`osid.topology.Graph`		the new `Graph`
Errors	ILLEGAL_STATE		`graphForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`graphForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`graphForm` did not originate from `getGraphFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateGraphs
Description	Tests if this user can update `Graphs.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Graph` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `Graph` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGraphFormForUpdate
Description	Gets the graph form for updating an existing graph. A new graph form should be requested for each update transaction.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.GraphForm`		the graph form
Errors	NOT_FOUND		`graphId` is not found
	NULL_ARGUMENT		`graphId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateGraph
Description	Updates an existing graph
Parameters	`osid.topology.GraphForm`	`graphForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`graphForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`graphForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`graphForm` did not originate from `getGraphFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteGraphs
Description	Tests if this user can delete `Graphs.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Graph` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `Graph` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteGraph
Description	Deletes a `Graph.`
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph` to remove
Errors	NOT_FOUND		`graphId` not found
	NULL_ARGUMENT		`graphId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageGraphAliases
Description	Tests if this user can manage `Id` aliases for graphs. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Graph` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasGraph
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` performs as an alias to the primary `Id.` If the alias is a pointer to another graph, it is reassigned to the given graph `Id.`
Parameters	`osid.id.Id`	`graphId`	the `Id` of a `Graph`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`graphId` not found
	NULL_ARGUMENT		`graphId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.