OSID Logo
OSID Specifications
topology rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.rules.EdgeEnablerGraphAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to re-assign EdgeEnabler to Graph mappings. An EdgeEnabler may appear in multiple Graph objects and removing the last reference to an EdgeEnabler is the equivalent of deleting it. Each Graph may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an EdgeEnabler to another Graph is not a copy operation (eg: does not change its Id ).

MethodcanAssignEdgeEnablers
Description

Tests if this user can alter edge enabler/graph 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.
MethodcanAssignEdgeEnablersToGraph
Description

Tests if this user can alter edge enabler/graph 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.

Parametersosid.id.IdgraphIdthe Id of the Graph
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT graphId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableGraphIds
Description

Gets a list of ontologies including and under the given graph node in which any edge enabler can be assigned.

Parametersosid.id.IdgraphIdthe Id of the Graph
Returnosid.id.IdListlist of assignable graph Ids
ErrorsNULL_ARGUMENT graphId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableGraphIdsForEdgeEnabler
Description

Gets a list of ontologies including and under the given graph node in which a specific edge enabler can be assigned.

Parametersosid.id.IdgraphIdthe Id of the Graph
osid.id.IdedgeEnablerIdthe Id of the EdgeEnabler
Returnosid.id.IdListlist of assignable graph Ids
ErrorsNULL_ARGUMENT graphId or edgeEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignEdgeEnablerToGraph
Description

Adds an existing EdgeEnabler to a Graph.

Parametersosid.id.IdedgeEnablerIdthe Id of the EdgeEnabler
osid.id.IdgraphIdthe Id of the Graph
ErrorsALREADY_EXISTS edgeEnablerId is already assigned to graphId
NOT_FOUND edgeEnablerId or graphId not found
NULL_ARGUMENT edgeEnablerId or graphId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignEdgeEnablerFromGraph
Description

Removes an EdgeEnabler from a Graph.

Parametersosid.id.IdedgeEnablerIdthe Id of the EdgeEnabler
osid.id.IdgraphIdthe Id of the Graph
ErrorsNOT_FOUND edgeEnablerId or graphId not found or edgeEnablerId not assigned to graphId
NULL_ARGUMENT edgeEnablerId or graphId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignEdgeEnablerToGraph
Description

Moves an EdgeEnabler from one Graph to another. Mappings to other Graphs are unaffected.

Parametersosid.id.IdedgeEnablerIdthe Id of the EdgeEnabler
osid.id.IdfromGraphIdthe Id of the current Graph
osid.id.IdtoGraphIdthe Id of the destination Graph
ErrorsNOT_FOUND edgeEnablerId, fromGraphId, or toGraphId not found or edgeEnablerId not mapped to fromGraphId
NULL_ARGUMENT edgeEnabelrId, fromGraphId, or toGraphId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.