Interface | osid.mapping.path.rules.SignalEnablerLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
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 | ||
Method | getMapId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Map Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getMap | ||
Description |
Gets the | ||
Return | osid.mapping.Map | the map | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupSignalEnablers | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeSignalEnablerView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenarySignalEnablerView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedMapView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedMapView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this maps only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useActiveSignalEnablerView | ||
Description |
Only active signal enablers are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusSignalEnablerView | ||
Description |
All active and inactive signal enablers are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSignalEnabler | ||
Description |
Gets the In active mode, signal enablers are returned that are currently active. In any status mode, active and inactive signal enablers are returned. | ||
Parameters | osid.id.Id | signalEnablerId | Id of the SignalEnabler |
Return | osid.mapping.path.rules.SignalEnabler | the signal enabler | |
Errors | NOT_FOUND | signalEnablerId not found | |
NULL_ARGUMENT | signalEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSignalEnablersByIds | ||
Description |
Gets a In active mode, signal enablers are returned that are currently active. In any status mode, active and inactive signal enablers are returned. | ||
Parameters | osid.id.IdList | signalEnablerIds | the list of Ids to retrieve |
Return | osid.mapping.path.rules.SignalEnablerList | the returned SignalEnabler list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | signalEnablerIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSignalEnablersByGenusType | ||
Description |
Gets a In active mode, signal enablers are returned that are currently active. In any status mode, active and inactive signal enablers are returned. | ||
Parameters | osid.type.Type | signalEnablerGenusType | a signal enabler genus type |
Return | osid.mapping.path.rules.SignalEnablerList | the returned SignalEnabler list | |
Errors | NULL_ARGUMENT | signalEnablerGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSignalEnablersByParentGenusType | ||
Description |
Gets a In active mode, signal enablers are returned that are currently active. In any status mode, active and inactive signal enablers are returned. | ||
Parameters | osid.type.Type | signalEnablerGenusType | a signal enabler genus type |
Return | osid.mapping.path.rules.SignalEnablerList | the returned SignalEnabler list | |
Errors | NULL_ARGUMENT | signalEnablerGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSignalEnablersByRecordType | ||
Description |
Gets a In active mode, signal enablers are returned that are currently active. In any status mode, active and inactive signal enablers are returned. | ||
Parameters | osid.type.Type | signalEnablerRecordType | a signal enabler record type |
Return | osid.mapping.path.rules.SignalEnablerList | the returned SignalEnabler list | |
Errors | NULL_ARGUMENT | signalEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSignalEnablersOnDate | ||
Description |
Gets a 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. | ||
Parameters | osid.calendaring.DateTime | from | a start date |
osid.calendaring.DateTime | to | an end date | |
Return | osid.mapping.path.rules.SignalEnablerList | the returned SignalEnabler list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSignalEnablersOnDateWithAgent | ||
Description |
Gets a 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. | ||
Parameters | osid.id.Id | agentId | an agent Id |
osid.calendaring.DateTime | from | a start date | |
osid.calendaring.DateTime | to | an end date | |
Return | osid.mapping.path.rules.SignalEnablerList | the returned SignalEnabler list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | agentId, from, or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSignalEnablers | ||
Description |
Gets all 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. | ||
Return | osid.mapping.path.rules.SignalEnablerList | the returned SignalEnabler list | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |