OSID - osid.topology.NodeAdminSession Service Interface Definition

Interface	osid.topology.NodeAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Nodes.` 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 `Node,` a `NodeForm` is requested using `getNodeFormForCreate()` specifying desired record `Types` or none if no record `Types` are needed. The returned `NodeForm` 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 `NodeForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `NodeForm` corresponds to an attempted transaction. For updates, `NodeForms` are requested to the `Node` `Id` that is to be updated using `getNodeFormForUpdate().` Similarly, the `NodeForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `NodeForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Nodes.` To unmap a `Node` from the current `Graph,` the `NodeGraphAssignmentSession` should be used. These delete operations attempt to remove the `Node` 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	canCreateNodes
Description	Tests if this user can create `Nodes.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Node` 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 `Node` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateNodeWithRecordTypes
Description	Tests if this user can create a single `Node` using the desired record types. While `TopologyManager.getNodeRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Node.` Providing an empty array tests if a `Node` can be created with no records.
Parameters	`osid.type.Type[]`	`nodeRecordTypes`	array of node record types
Return	`boolean`		`true` if `Node` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`nodeRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getNodeFormForCreate
Description	Gets the node form for creating new nodes. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`nodeRecordTypes`	array of node record types
Return	`osid.topology.NodeForm`		the node form
Errors	NULL_ARGUMENT		`nodeRecordTypes` 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	createNode
Description	Creates a new `Node.`
Parameters	`osid.topology.NodeForm`	`nodeForm`	the form for this `Node`
Return	`osid.topology.Node`		the new `Node`
Errors	ILLEGAL_STATE		nodeForm already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`nodeForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`nodeForm` did not originate from `getNodeFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateNodes
Description	Tests if this user can update `Nodes.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Node` 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 `Node` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getNodeFormForUpdate
Description	Gets the node form for updating an existing node. A new node form should be requested for each update transaction.
Parameters	`osid.id.Id`	`nodeId`	the `Id` of the `Node`
Return	`osid.topology.NodeForm`		the node form
Errors	NOT_FOUND		`nodeId` is not found
	NULL_ARGUMENT		`nodeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateNode
Description	Updates an existing node.
Parameters	`osid.topology.NodeForm`	`nodeForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`nodeForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`nodeForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`nodeForm` did not originate from `getNodeFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteNodes
Description	Tests if this user can delete `Nodes.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Node` 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 `Node` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteNode
Description	Deletes a `Node.`
Parameters	`osid.id.Id`	`nodeId`	the `Id` of the `Node` to remove
Errors	NOT_FOUND		`nodeId` not found
	NULL_ARGUMENT		`nodeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageNodeAliases
Description	Tests if this user can manage `Id` aliases for node entries. 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 `Node` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasNode
Description	Adds an `Id` to a `Node` for the purpose of creating compatibility. The primary `Id` of the `Node` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another node, it is reassigned to the given node `Id.`
Parameters	`osid.id.Id`	`nodeId`	the `Id` of a `Node`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`nodeId` not found
	NULL_ARGUMENT		`nodeId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.