OSID - osid.mapping.path.rules.SignalEnablerLookupSession Service Interface Definition

Interface	osid.mapping.path.rules.SignalEnablerLookupSession
Implements	`osid.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.
Method	getMapId
Description	Gets the `Map` `Id` associated with this session.
Return	`osid.id.Id`		the `Map Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getMap
Description	Gets the `Map` associated with this session.
Return	`osid.mapping.Map`		the map
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupSignalEnablers
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.
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 `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.
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 `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.
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 `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.
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 `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.
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 `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.
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 `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.
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 `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.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`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 `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.
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 `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.
Return	`osid.mapping.path.rules.SignalEnablerList`		the returned `SignalEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.