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

This session defines methods to receive notifications for signal crossings in this Map. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.

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.
MethodcanRegisterForResourceSignalNotifications
Description

Tests if this user can register for notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may wish not to offer notification operations to unauthorized users.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedMapView
Description

Federates the view for methods in this session. A federated view will include signals in maps which are children of this map in the map hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedMapView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this map only.

CompliancemandatoryThis method is must be implemented.
MethodregisterForSignals
Description

Register for notifications of resources passing signals. ResourceSignalReceiver.crossedSignal() is invoked when a resource crosses a signal.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForCrossedSignal
Description

Register for notifications of resources crossing a given signal. ResourceSignalReceiver.crossedSignal() is invoked when a resource crosses the designated signal.

Parametersosid.id.IdsignalIdthe Id of the Signal to monitor
ErrorsNULL_ARGUMENT signalId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForCrossedSignalsForResource
Description

Register for notifications of resources crossing signals. ResourcePathReceiver.crossedSignal() is invoked when the specified resource crosses a signal.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForCrossedSignalsForResourcesByGenusType
Description

Register for notifications of resources crossing signals for resources of the given genus type. ResourcePathReceiver.crossedSignal() is invoked when the specified resource crosses a signal.

Parametersosid.type.TyperesourceGenusTypethe genus type of the Resource to monitor
ErrorsNULL_ARGUMENT resourceGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForCrossedSignalsByPath
Description

Register for notifications of resources crossing signals on the given path. ResourcePathReceiver.crossedSignal() is invoked when the specified resource crosses a signal.

Parametersosid.id.IdpathIdthe Id of the Path to monitor
ErrorsNULL_ARGUMENT pathId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.