OSID Logo
OSID Specifications
mapping path rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.rules.ObstacleEnablerRuleApplicationSession
Implementsosid.OsidSession
Description

This session provides methods to apply ObstacleEnablers to Obstacles. An Obstacle with multiple ObstacleEnablers means any positive rule evaluation across the enablers result in an enabled Obstacle.

MethodgetMapId
Description

Gets the Map Id associated with this session.

Returnosid.id.Idthe Map Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetMap
Description

Gets the Map associated with this session.

Returnosid.mapping.Mapthe map
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAssignObstacleEnablers
Description

Tests if this user can alter obstacle enabler/obstacle 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.
MethodassignObstacleEnablerToObstacle
Description

Adds an existing ObstacleEnabler to an Obstacle.

Parametersosid.id.IdobstacleEnablerIdthe Id of the ObstacleEnabler
osid.id.IdobstacleIdthe Id of the Obstacle
ErrorsALREADY_EXISTS obstacleEnablerId is already applied to obstacleId
NOT_FOUND obstacleEnablerId or obstacleId not found
NULL_ARGUMENT obstacleEnablerId or obstacleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignObstacleEnablerFromObstacle
Description

Removes an ObstacleEnabler from an Obstacle.

Parametersosid.id.IdobstacleEnablerIdthe Id of the ObstacleEnabler
osid.id.IdobstacleIdthe Id of the Obstacle
ErrorsNOT_FOUND obstacleEnablerId or obstacleId not found or obstacleEnablerId not applied to obstacleId
NULL_ARGUMENT obstacleEnablerId or obstacleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceObstacleEnablers
Description

Tests if this user can order ObstacleEnablers. 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 ObstacleEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveObstacleEnablerAhead
Description

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

Parametersosid.id.IdobstacleEnablerIdthe Id of an ObstacleEnabler
osid.id.IdobstacleIdthe Id of an Obstacle
osid.id.IdreferenceIdthe reference obstacle enabler Id
ErrorsNOT_FOUND obstacleEnablerId, obstacleId, or referenceId not found or, obstacleEnablerId or referenceId not related to obstacleId
NULL_ARGUMENT obstacleEnablerId, obstacleId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveObstacleEnablerBehind
Description

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

Parametersosid.id.IdobstacleEnablerIdthe Id of an ObstacleEnabler
osid.id.IdobstacleIdthe Id of an Obstacle
osid.id.IdreferenceIdthe reference obstacle enabler Id
ErrorsNOT_FOUND obstacleEnablerId, obstacleId, or referenceId not found or, obstacleEnablerId or referenceId not related to obstacleId
NULL_ARGUMENT obstacleEnablerId, obstacleId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderObstacleEnablers
Description

Reorders a set of obstacle enablers for an obstacle.

Parametersosid.id.Id[]obstacleEnablerIdsthe Ids for a set of ObstacleEnablers
osid.id.IdobstacleIdthe Id of an Obstacle
ErrorsNOT_FOUND obstacleId not found or, an obstacleEnablerId not related to obstacleId
NULL_ARGUMENT obstacleEnabelrIds or obstacleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.