OSID Logo
OSID Specifications
topology package
Version 3.1.0
Interfaceosid.topology.EdgeGraphAssignmentSession
Implementsosid.OsidSession
Used Byosid.topology.TopologyManager
osid.topology.TopologyProxyManager
Description

This session provides methods to re-assign Edges to Graph objects An Edge may appear in multiple Graph objects and removing the last reference to an Edge 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 Edge to another Graph is not a copy operation (eg: does not change its Id).

MethodcanAssignEdges
Description

Tests if this user can alter edge/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 assignment operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodcanAssignEdgesToGraph
Description

Tests if this user can alter edge/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 assignment operations to unauthorized users.

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

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

Parametersosid.id.IdgraphId the Id of the Graph
Returnosid.id.IdList list of assignable graph Ids
ErrorsNULL_ARGUMENT graphId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAssignableGraphIdsForEdge
Description

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

Parametersosid.id.IdgraphId the Id of the Graph
osid.id.IdedgeId the Id of the Edge
Returnosid.id.IdList list of assignable graph Ids
ErrorsNULL_ARGUMENT graphId or edgeId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignEdgeToGraph
Description

Adds an existing Edge to a Graph.

Parametersosid.id.IdedgeId the Id of the Edge
osid.id.IdgraphId the Id of the Graph
ErrorsALREADY_EXISTS edgeId is already assigned to graphId
NOT_FOUND edgeId or graphId not found
NULL_ARGUMENT edgeId or graphId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignEdgeFromGraph
Description

Removes an Edge from a Graph .

Parametersosid.id.IdedgeId the Id of the Edge
osid.id.IdgraphId the Id of the Graph
ErrorsNOT_FOUND edgeId or graphId not found or edgeId not assigned to graphId
NULL_ARGUMENT edgeId or graphId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignEdgeToGraph
Description

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

Parametersosid.id.IdedgeId the Id of the Edge
osid.id.IdfromGraphId the Id of the current Graph
osid.id.IdtoGraphId the Id of the destination Graph
ErrorsALREADY_EXISTS edgeId already assigned to toGraphId
NOT_FOUND edgeId, fromGraphId, or toGraphId not found or edgeId not mapped to fromGraphId
NULL_ARGUMENT edgeId, fromGraphId, or toGraphId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.