OSID - osid.topology.rules.EdgeEnablerRuleApplicationSession Service Interface Definition

Interface	osid.topology.rules.EdgeEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.topology.rules.TopologyRulesManager`
Used By	`osid.topology.rules.TopologyRulesProxyManager`
Description	This session provides methods to apply `EdgeEnablers` to `Edges`. An `Edge` with multiple `EdgeEnablers` means any positive rule evaluation across the enablers result in an effective `Edge`.
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	canAssignEdgeEnablers
Description	Tests if this user can alter edge enabler/edge mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	assignEdgeEnablerToEdge
Description	Adds an existing `EdgeEnabler` to an `Edge`.
Parameters	`osid.id.Id`	`edgeEnablerId`	the `Id` of the `EdgeEnabler`
Parameters	`osid.id.Id`	`edgeId`	the `Id` of the `Edge`
Errors	ALREADY_EXISTS		`edgeEnablerId` is already applied to `edgeId`
	NOT_FOUND		`edgeEnablerId` or `edgeId` not found
	NULL_ARGUMENT		`edgeEnablerId` or `edgeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignEdgeEnablerFromEdge
Description	Removes an `EdgeEnabler` from an `Edge`.
Parameters	`osid.id.Id`	`edgeEnablerId`	the `Id` of the `EdgeEnabler`
Parameters	`osid.id.Id`	`edgeId`	the `Id` of the `Edge`
Errors	NOT_FOUND		`edgeEnablerId` or `edgeId` not found or `edgeEnablerId` is not applied to `edgeId`
	NULL_ARGUMENT		`edgeEnablerId` or `edgeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceEdgeEnablers
Description	Tests if this user can order `EdgeEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
Return	`boolean`		`false` if `EdgeEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveEdgeEnablerAhead
Description	Reorders edge enablers for an edge by moving the specified edge enabler in front of a reference edge enabler.
Parameters	`osid.id.Id`	`edgeEnablerId`	the `Id` of an `EdgeEnabler`
	`osid.id.Id`	`edgeId`	the `Id` of an `Edge`
	`osid.id.Id`	`referenceId`	the reference edge enabler `Id`
Errors	NOT_FOUND		`edgeEnablerId, edgeId`, or `referenceId` not found or, `edgeEnablerId` or `referenceId` not related to `edgeId`
	NULL_ARGUMENT		`edgeEnablerId, edgeId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveEdgeEnablerBehind
Description	Reorders edge enablers for an edge by moving the specified edge enabler behind a reference edge enabler.
Parameters	`osid.id.Id`	`edgeEnablerId`	the `Id` of an `EdgeEnabler`
	`osid.id.Id`	`edgeId`	the `Id` of an `Edge`
	`osid.id.Id`	`referenceId`	the reference edge enabler `Id`
Errors	NOT_FOUND		`edgeEnablerId, edgeId`, or `referenceId` not found or, `edgeEnablerId` or `referenceId` not related to `edgeId`
	NULL_ARGUMENT		`edgeEnablerId, edgeId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderEdgeEnablers
Description	Reorders a set of edge enablers for an edge.
Parameters	`osid.id.Id[]`	`edgeEnablerIds`	the `Ids` for a set of `EdgeEnablers`
Parameters	`osid.id.Id`	`edgeId`	the `Id` of an `Edge`
Errors	NOT_FOUND		`edgeId` not found or, an `edgeEnablerId` not related to `edgeId`
	NULL_ARGUMENT		`edgeEnablerIds` or `edgeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.