OSID Logo
OSID Specifications
topology rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.rules.EdgeEnablerRuleApplicationSession
Implementsosid.OsidSession
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.

MethodgetGraphId
Description

Gets the Graph Id associated with this session.

Returnosid.id.Idthe Graph Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetGraph
Description

Gets the Graph associated with this session.

Returnosid.topology.Graphthe graph
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAssignEdgeEnablers
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.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodassignEdgeEnablerToEdge
Description

Adds an existing EdgeEnabler to an Edge.

Parametersosid.id.IdedgeEnablerIdthe Id of the EdgeEnabler
osid.id.IdedgeIdthe Id of the Edge
ErrorsALREADY_EXISTS edgeEnablerId is already applied to edgeId
NOT_FOUND edgeEnablerId or edgeId not found
NULL_ARGUMENT edgeEnablerId or edgeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignEdgeEnablerFromEdge
Description

Removes an EdgeEnabler from an Edge.

Parametersosid.id.IdedgeEnablerIdthe Id of the EdgeEnabler
osid.id.IdedgeIdthe Id of the Edge
ErrorsNOT_FOUND edgeEnablerId or edgeId not found or edgeEnablerId is not applied to edgeId
NULL_ARGUMENT edgeEnablerId or edgeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceEdgeEnablers
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.

Returnboolean false if EdgeEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveEdgeEnablerAhead
Description

Reorders edge enablers for an edge by moving the specified edge enabler in front of a reference edge enabler.

Parametersosid.id.IdedgeEnablerIdthe Id of an EdgeEnabler
osid.id.IdedgeIdthe Id of an Edge
osid.id.IdreferenceIdthe reference edge enabler Id
ErrorsNOT_FOUND edgeEnablerId, edgeId, or referenceId not found or, edgeEnablerId or referenceId not related to edgeId
NULL_ARGUMENT edgeEnablerId, edgeId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveEdgeEnablerBehind
Description

Reorders edge enablers for an edge by moving the specified edge enabler behind a reference edge enabler.

Parametersosid.id.IdedgeEnablerIdthe Id of an EdgeEnabler
osid.id.IdedgeIdthe Id of an Edge
osid.id.IdreferenceIdthe reference edge enabler Id
ErrorsNOT_FOUND edgeEnablerId, edgeId, or referenceId not found or, edgeEnablerId or referenceId not related to edgeId
NULL_ARGUMENT edgeEnablerId, edgeId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderEdgeEnablers
Description

Reorders a set of edge enablers for an edge.

Parametersosid.id.Id[]edgeEnablerIdsthe Ids for a set of EdgeEnablers
osid.id.IdedgeIdthe Id of an Edge
ErrorsNOT_FOUND edgeId not found or, an edgeEnablerId not related to edgeId
NULL_ARGUMENT edgeEnablerIds or edgeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.