OSID - osid.topology.path.PathAdminSession Service Interface Definition

Interface	osid.topology.path.PathAdminSession
Implements	`osid.OsidSession`
Used By	`osid.topology.path.TopologyPathManager`
Used By	`osid.topology.path.TopologyPathProxyManager`
Description	This session creates, updates, and deletes `Paths`. 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 `Path`, a `PathForm` is requested using `gePathFormForCreate()` specifying desired record `Types` or none if no record `Types` are needed. The returned `PathForm` 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 `PathForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `PathForm` corresponds to an attempted transaction. For updates, `PathForms` are requested to the `Path` `Id` that is to be updated using `getPathFormForUpdate()`. Similarly, the `PathForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `PathForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Paths`. To unmap a `Path` from the current `Graph`, the `PathGraphAssignmentSession` should be used. These delete operations attempt to remove the `Path` 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	canCreatePaths
Description	Tests if this user can create `Paths`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Path` 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 `Path` ceration is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreatePathWithRecordTypes
Description	Tests if this user can create a single `Path` using the desired record types. While `TopologyManager.getPathRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Path`. Providing an empty array tests if a `Path` can be created with no records.
Parameters	`osid.type.Type[]`	`pathRecordTypes`	array of path record types
Return	`boolean`		`true` if `Path` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`pathRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPathFormForCreate
Description	Gets the path form for creating new paths. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`startingNodeId`	the `Id` of the starting location
	`osid.id.Id`	`endingNodeId`	the `Id` of the ending location
	`osid.type.Type[]`	`pathRecordTypes`	array of path record types
Return	`osid.topology.path.PathForm`		the path form
Errors	NOT_FOUND		`startingLocationId` or `endingLocationId` is not found
	NULL_ARGUMENT		`startingLocationId, endingLocationId`, or `pathRecordTypes` 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	createPath
Description	Creates a new `Path`.
Parameters	`osid.topology.path.PathForm`	`pathForm`	the form for this `Path`
Return	`osid.topology.path.Path`		the new `Path`
Errors	ILLEGAL_STATE		`pathForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`pathForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`pathForm` did not originate from `getPathFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdatePaths
Description	Tests if this user can update `Paths`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Path` 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 `Path` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPathFormForUpdate
Description	Gets the path form for updating an existing path. A new path form should be requested for each update transaction.
Parameters	`osid.id.Id`	`pathId`	the `Id` of the `Path`
Return	`osid.topology.path.PathForm`		the path form
Errors	NOT_FOUND		`pathId` is not found
	NULL_ARGUMENT		`pathId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updatePath
Description	Updates an existing path.
Parameters	`osid.topology.path.PathForm`	`pathForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`pathForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`pathForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`pathForm` did not originate from `getPathFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeletePaths
Description	Tests if this user can delete `Paths`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Path` 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 `Path` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deletePath
Description	Deletes a `Path`.
Parameters	`osid.id.Id`	`pathId`	the `Id` of the `Path` to remove
Errors	NOT_FOUND		`pathId` not found
	NULL_ARGUMENT		`pathId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addEdge
Description	Adds an edge to a path.
Parameters	`osid.id.Id`	`pathId`	the `Id` of a `Path`
Parameters	`osid.id.Id`	`edgeId`	the `Id` of the `Edge` to add
Errors	ALREADY_EXISTS		`edgeId` already in path
	NOT_FOUND		`pathId` or `edgeId` not found
	NULL_ARGUMENT		`pathId` or `edgeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addEdges
Description	Adds edges to a path.
Parameters	`osid.id.Id`	`pathId`	the `Id` of `Path`
Parameters	`osid.id.IdList`	`edgeIds`	the `Ids` of the `Edges` to add
Errors	ALREADY_EXISTS		`edgeId` already in path
	NOT_FOUND		`pathId` or an `edgeId` not found
	NULL_ARGUMENT		`pathId` or `edgeIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeEdge
Description	Removes an edge from a path.
Parameters	`osid.id.Id`	`pathId`	the `Id` of a `Path`
Parameters	`osid.id.Id`	`edgeId`	the `Id` of the `Edge` to add
Errors	NOT_FOUND		`pathId` does not contain `edgeId`
	NULL_ARGUMENT		`pathId` or `edgeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeEdges
Description	Removes edges from a path.
Parameters	`osid.id.Id`	`pathId`	the `Id` of a `Path`
Parameters	`osid.id.IdList`	`edgeIds`	the list of `Ids` of the `Edges` to add
Errors	NOT_FOUND		`pathId` does not contain an `edgeId`
	NULL_ARGUMENT		`pathId` or `edgeIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManagePathAliases
Description	Tests if this user can manage `Id` aliases for `Paths`. 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 `Path` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasPath
Description	Adds an `Id` to a `Path` for the purpose of creating compatibility. The primary `Id` of the `Path` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another path, it is reassigned to the given node `Id`.
Parameters	`osid.id.Id`	`pathId`	the `Id` of a `Path`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`pathId` not found
	NULL_ARGUMENT		`pathId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.