OSID - osid.topology.EdgeAdminSession Service Interface Definition

Interface	osid.topology.EdgeAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Edges.` 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 `geEdgeFormForCreate()` specifying the `nodes` and desired record `Types` or none if no record `Types` are needed. The returned `EdgeForm` 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 `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. For updates, `EdgeForms` are requested to the `Edge` `Id` that is to be updated using `getEdgeFormForUpdate().` 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. The delete operations delete `Edges.` 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. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getGraphId
Description	Gets the `Graph` `Id` associated with this session.
Return	`osid.id.Id`		the `Graph Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getGraph
Description	Gets the `Graph` associated with this session.
Return	`osid.topology.Graph`		the graph
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateEdges
Description	Tests if this user can create `Edges.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Edge` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `Edge` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateEdgeWithRecordTypes
Description	Tests if this user can create a single `Edge` using the desired record types. While `TopologyManager.getEdgeRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Edge.` Providing an empty array tests if an `Edge` can be created with no records.
Parameters	`osid.type.Type[]`	`edgeRecordTypes`	array of edge record types
Return	`boolean`		`true` if `Edge` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`edgeRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEdgeFormForCreate
Description	Gets the edge form for creating new edges. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`sourceNodeId`	the `Id` of the starting node.
	`osid.id.Id`	`destinationNodeId`	the `Id` of the ending node.
	`osid.type.Type[]`	`edgeRecordTypes`	array of edge record types
Return	`osid.topology.EdgeForm`		the edge form
Errors	NOT_FOUND		`sourceNodeId` or `destinationNodeId` is not found
	NULL_ARGUMENT		`sourceNodeId, destinationNodeId,` or `edgeRecordTypes` 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	createEdge
Description	Creates a new `Edge.`
Parameters	`osid.topology.EdgeForm`	`edgeForm`	the form for this `Edge`
Return	`osid.topology.Edge`		the new `Edge`
Errors	ILLEGAL_STATE		`edgeForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`edgeForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`edgeForm` did not originate from `getEdgeFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateEdges
Description	Tests if this user can update `Edges.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Edge` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `Edge` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEdgeFormForUpdate
Description	Gets the edge form for updating an existing edge. A new edge form should be requested for each update transaction.
Parameters	`osid.id.Id`	`edgeId`	the `Id` of the `Edge`
Return	`osid.topology.EdgeForm`		the edge form
Errors	NOT_FOUND		`edgeId` is not found
	NULL_ARGUMENT		`edgeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateEdge
Description	Updates an existing edge.
Parameters	`osid.topology.EdgeForm`	`edgeForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`edgeForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`edgeForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`edgeForm` did not originate from `getEdgeFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteEdges
Description	Tests if this user can delete `Edges.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Edge` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Edge` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteEdge
Description	Deletes an `Edge.`
Parameters	`osid.id.Id`	`edgeId`	the `Id` of the `Edge` to remove
Errors	NOT_FOUND		`edgeId` not found
	NULL_ARGUMENT		`edgeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageEdgeAliases
Description	Tests if this user can manage `Id` aliases for edges. 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 `Edge` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasEdge
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` performs as an alias to the primary `Id.` If the alias is a pointer to another edge, it is reassigned to the given edge `Id.`
Parameters	`osid.id.Id`	`edgeId`	the `Id` of an `Edge`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`edgeId` not found
	NULL_ARGUMENT		`edgeId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.