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

This session provides methods for retrieving SignalEnablers.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated map view: All signal enabler methods in this session operate, retrieve and pertain to signal enabler defined explicitly in the current map. Using an isolated view is useful for managing SignalEnablers with the SignalEnablerAdminSession.
  • federated map view: All signal enabler methods in this session operate, retrieve and pertain to all signal enabler defined in this map and any other signal enabler implicitly available in this map through map inheritence.
  • active signal enabler view: All signal enabler lookup methods return active signal enablers.
  • any status signal enabler view: Signal enablers of any active or inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedMapView() and useIsolatedMapView() behave as a radio group and one should be selected before invoking the methods in this session.

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

Tests if this user can perform SignalEnablers lookups. 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 opt not to offer lookup operations to unauthorized users.

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

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenarySignalEnablerView
Description

A complete view of the SignalEnabler returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedMapView
Description

Federates the view for methods in this session. A federated view will include signal enabler in map 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 lookups to this maps only.

CompliancemandatoryThis method is must be implemented.
MethoduseActiveSignalEnablerView
Description

Only active signal enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusSignalEnablerView
Description

All active and inactive signal enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetSignalEnabler
Description

Gets the SignalEnabler specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned SignalEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a SignalEnabler and retained for compatibility.

In active mode, signal enablers are returned that are currently active. In any status mode, active and inactive signal enablers are returned.

Parametersosid.id.IdsignalEnablerId Id of the SignalEnabler
Returnosid.mapping.path.rules.SignalEnablerthe signal enabler
ErrorsNOT_FOUND signalEnablerId not found
NULL_ARGUMENT signalEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetSignalEnablersByIds
Description

Gets a SignalEnablerList corresponding to the given IdList.

In plenary mode, the returned list contains all of the signal enabler specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible SignalEnablers may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, signal enablers are returned that are currently active. In any status mode, active and inactive signal enablers are returned.

Parametersosid.id.IdListsignalEnablerIdsthe list of Ids to retrieve
Returnosid.mapping.path.rules.SignalEnablerListthe returned SignalEnabler list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT signalEnablerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSignalEnablersByGenusType
Description

Gets a SignalEnablerList corresponding to the given signal enabler genus Type which does not include signal enabler of genus types derived from the specified Type.

In plenary mode, the returned list contains all known signal enabler or an error results. Otherwise, the returned list may contain only those signal enabler that are accessible through this session.

In active mode, signal enablers are returned that are currently active. In any status mode, active and inactive signal enablers are returned.

Parametersosid.type.TypesignalEnablerGenusTypea signal enabler genus type
Returnosid.mapping.path.rules.SignalEnablerListthe returned SignalEnabler list
ErrorsNULL_ARGUMENT signalEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSignalEnablersByParentGenusType
Description

Gets a SignalEnablerList corresponding to the given signal enabler genus Type and include any additional signal enabler with genus types derived from the specified Type.

In plenary mode, the returned list contains all known signal enabler or an error results. Otherwise, the returned list may contain only those signal enabler that are accessible through this session.

In active mode, signal enablers are returned that are currently active. In any status mode, active and inactive signal enablers are returned.

Parametersosid.type.TypesignalEnablerGenusTypea signal enabler genus type
Returnosid.mapping.path.rules.SignalEnablerListthe returned SignalEnabler list
ErrorsNULL_ARGUMENT signalEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSignalEnablersByRecordType
Description

Gets a SignalEnablerList containing the given signal enabler record Type.

In plenary mode, the returned list contains all known signal enabler or an error results. Otherwise, the returned list may contain only those signal enabler that are accessible through this session.

In active mode, signal enablers are returned that are currently active. In any status mode, active and inactive signal enablers are returned.

Parametersosid.type.TypesignalEnablerRecordTypea signal enabler record type
Returnosid.mapping.path.rules.SignalEnablerListthe returned SignalEnabler list
ErrorsNULL_ARGUMENT signalEnablerRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSignalEnablersOnDate
Description

Gets a SignalEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent.

In plenary mode, the returned list contains all known signal enablers or an error results. Otherwise, the returned list may contain only those signal enablers that are accessible through this session.

In active mode, signal enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive signal enablers are returned.

Parametersosid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.mapping.path.rules.SignalEnablerListthe returned SignalEnabler list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSignalEnablersOnDateWithAgent
Description

Gets a SignalEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent.

In plenary mode, the returned list contains all known signal enablers or an error results. Otherwise, the returned list may contain only those signal enablers that are accessible through this session.

In active mode, signal enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive signal enablers are returned.

Parametersosid.id.IdagentIdan agent Id
osid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.mapping.path.rules.SignalEnablerListthe returned SignalEnabler list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT agentId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSignalEnablers
Description

Gets all SignalEnablers.

In plenary mode, the returned list contains all known signal enabler or an error results. Otherwise, the returned list may contain only those signal enabler that are accessible through this session.

In active mode, signal enablers are returned that are currently active. In any status mode, active and inactive signal enablers are returned.

Returnosid.mapping.path.rules.SignalEnablerListthe returned SignalEnabler list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.