OSID - osid.topology.rules.EdgeEnablerLookupSession Service Interface Definition

Interface	osid.topology.rules.EdgeEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `EdgeEnablers.` 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 graph view: All edge enabler methods in this session operate, retrieve and pertain to edge enablers defined explicitly in the current graph. Using an isolated view is useful for managing `EdgeEnablers` with the `EdgeEnablerAdminSession.` federated graph view: All edge enabler methods in this session operate, retrieve and pertain to all edge enablers defined in this graph and any other edge enablers implicitly available in this graph through graph inheritence. active edge enabler view: All edge enabler lookup methods return active edge enablers. any status edge enabler view: Edge 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 `useFederatedDistributorView()` and `useIsolatedDistributorView()` behave as a radio group and one should be selected before invoking the methods in this session.
Method	getGraphId
Description	Gets the `Graph` `Id` associated with this session.
Return	`osid.id.Id`		the `Graph Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getGraph
Description	Gets the `Graph` associated with this session.
Return	`osid.topology.Graph`		the graph
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupEdgeEnablers
Description	Tests if this user can perform `EdgeEnablers` 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	useComparativeEdgeEnablerView
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	usePlenaryEdgeEnablerView
Description	A complete view of the `EdgeEnabler` 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	useFederatedGraphView
Description	Federates the view for methods in this session. A federated view will include edge enablers in ontologies which are children of this graph in the graph hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedGraphView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this graph only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveEdgeEnablerView
Description	Only active edge enablers are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusEdgeEnablerView
Description	All active and inactive edge enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getEdgeEnabler
Description	Gets the `EdgeEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `EdgeEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `EdgeEnabler` and retained for compatibility. In active mode, edge enablers are returned that are currently active. In any status mode, active and inactive edge enablers are returned.
Parameters	`osid.id.Id`	`edgeEnablerId`	`Id` of the `EdgeEnabler`
Return	`osid.topology.rules.EdgeEnabler`		the edge enabler
Errors	NOT_FOUND		`edgeEnablerId` not found
	NULL_ARGUMENT		`edgeEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getEdgeEnablersByIds
Description	Gets an `EdgeEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the edge enablers 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 `EdgeEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, edge enablers are returned that are currently active. In any status mode, active and inactive edge enablers are returned.
Parameters	`osid.id.IdList`	`edgeEnablerIds`	the list of `Ids` to retrieve
Return	`osid.topology.rules.EdgeEnablerList`		the returned `EdgeEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`edgeEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEdgeEnablersByGenusType
Description	Gets an `EdgeEnablerList` corresponding to the given edge enabler genus `Type` which does not include edge enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known edge enablers or an error results. Otherwise, the returned list may contain only those edge enablers that are accessible through this session. In active mode, edge enablers are returned that are currently active. In any status mode, active and inactive edge enablers are returned.
Parameters	`osid.type.Type`	`edgeEnablerGenusType`	an edge enabler genus type
Return	`osid.topology.rules.EdgeEnablerList`		the returned `EdgeEnabler` list
Errors	NULL_ARGUMENT		`edgeEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEdgeEnablersByParentGenusType
Description	Gets an `EdgeEnablerList` corresponding to the given edge enabler genus `Type` and include any additional edge enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known edge enablers or an error results. Otherwise, the returned list may contain only those edge enablers that are accessible through this session. In active mode, edge enablers are returned that are currently active. In any status mode, active and inactive edge enablers are returned.
Parameters	`osid.type.Type`	`edgeEnablerGenusType`	an edge enabler genus type
Return	`osid.topology.rules.EdgeEnablerList`		the returned `EdgeEnabler` list
Errors	NULL_ARGUMENT		`edgeEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEdgeEnablersByRecordType
Description	Gets an `EdgeEnablerList` containing the given edge enabler record `Type.` In plenary mode, the returned list contains all known edge enablers or an error results. Otherwise, the returned list may contain only those edge enablers that are accessible through this session. In active mode, edge enablers are returned that are currently active. In any status mode, active and inactive edge enablers are returned.
Parameters	`osid.type.Type`	`edgeEnablerRecordType`	an edge enabler record type
Return	`osid.topology.rules.EdgeEnablerList`		the returned `EdgeEnabler` list
Errors	NULL_ARGUMENT		`edgeEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEdgeEnablersOnDate
Description	Gets an `EdgeEnablerList` which 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 edge enablers or an error results. Otherwise, the returned list may contain only those edge enablers that are accessible through this session. In active mode, edge enablers are returned that are currently active. In any status mode, active and inactive edge enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.topology.rules.EdgeEnablerList`		the returned `EdgeEnabler` 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	getEdgeEnablersOnDateWithAgent
Description	Gets an `EdgeEnablerList` which 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 edge enablers or an error results. Otherwise, the returned list may contain only those edge enablers that are accessible through this session. In active mode, edge enablers are returned that are currently active. In any status mode, active and inactive edge 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.topology.rules.EdgeEnablerList`		the returned `EdgeEnabler` 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	getEdgeEnablers
Description	Gets all `EdgeEnablers.` In plenary mode, the returned list contains all known edge enablers or an error results. Otherwise, the returned list may contain only those edge enablers that are accessible through this session. In active mode, edge enablers are returned that are currently active. In any status mode, active and inactive edge enablers are returned.
Return	`osid.topology.rules.EdgeEnablerList`		the returned `EdgeEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.