Interface | osid.topology.rules.EdgeEnablerRuleApplicationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to apply | ||
Method | getGraphId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Graph Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getGraph | ||
Description |
Gets the | ||
Return | osid.topology.Graph | the graph | |
Errors | OPERATION_FAILED | unable to complete request | |
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
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | assignEdgeEnablerToEdge | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | edgeEnablerId | the Id of the EdgeEnabler |
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 | ||
Parameters | osid.id.Id | edgeEnablerId | the Id of the EdgeEnabler |
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 | ||
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 |
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. |