OSID - osid.ontology.rules.RelevancyEnablerLookupSession Service Interface Definition

Interface	osid.ontology.rules.RelevancyEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `RelevancyEnablers.` 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 ontology view: All relevancy enabler methods in this session operate, retrieve and pertain to relevancy enablers defined explicitly in the current ontology. Using an isolated view is useful for managing `RelevancyEnablers` with the `RelevancyEnablerAdminSession.` federated ontology view: All relevancy enabler methods in this session operate, retrieve and pertain to all relevancy enablers defined in this ontology and any other relevancy enablers implicitly available in this ontology through ontology inheritence. active relevancy enabler view: All relevancy enabler lookup methods return active relevancy enablers. any status relevancy enabler view: Relevancy 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	getOntologyId
Description	Gets the `Ontology` `Id` associated with this session.
Return	`osid.id.Id`		the `Ontology Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOntology
Description	Gets the `Ontology` associated with this session.
Return	`osid.ontology.Ontology`		the ontology
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupRelevancyEnablers
Description	Tests if this user can perform `RelevancyEnablers` 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	useComparativeRelevancyEnablerView
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	usePlenaryRelevancyEnablerView
Description	A complete view of the `RelevancyEnabler` 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	useFederatedOntologyView
Description	Federates the view for methods in this session. A federated view will include relevancy enablers in ontologies which are children of this ontology in the ontology hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedOntologyView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this ontology only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveRelevancyEnablerView
Description	Only active relevancy enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusRelevancyEnablerView
Description	All active and inactive relevancy enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getRelevancyEnabler
Description	Gets the `RelevancyEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `RelevancyEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `RelevancyEnabler` and retained for compatibility. In active mode, relevancy enablers are returned that are currently active. In any status mode, active and inactive relevancy enablers are returned.
Parameters	`osid.id.Id`	`relevancyEnablerId`	`Id` of the `RelevancyEnabler`
Return	`osid.ontology.rules.RelevancyEnabler`		the relevancy enabler
Errors	NOT_FOUND		`relevancyEnablerId` not found
	NULL_ARGUMENT		`relevancyEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getRelevancyEnablersByIds
Description	Gets a `RelevancyEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the relevancy 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 `RelevancyEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, relevancy enablers are returned that are currently active. In any status mode, active and inactive relevancy enablers are returned.
Parameters	`osid.id.IdList`	`relevancyEnablerIds`	the list of `Ids` to retrieve
Return	`osid.ontology.rules.RelevancyEnablerList`		the returned `RelevancyEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`relevancyEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancyEnablersByGenusType
Description	Gets a `RelevancyEnablerList` corresponding to the given relevancy enabler genus `Type` which does not include relevancy enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known relevancy enablers or an error results. Otherwise, the returned list may contain only those relevancy enablers that are accessible through this session. In active mode, relevancy enablers are returned that are currently active. In any status mode, active and inactive relevancy enablers are returned.
Parameters	`osid.type.Type`	`relevancyEnablerGenusType`	a relevancy enabler genus type
Return	`osid.ontology.rules.RelevancyEnablerList`		the returned `RelevancyEnabler` list
Errors	NULL_ARGUMENT		`relevancyEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancyEnablersByParentGenusType
Description	Gets a `RelevancyEnablerList` corresponding to the given relevancy enabler genus `Type` and include any additional relevancy enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known relevancy enablers or an error results. Otherwise, the returned list may contain only those relevancy enablers that are accessible through this session. In active mode, relevancy enablers are returned that are currently active. In any status mode, active and inactive relevancy enablers are returned.
Parameters	`osid.type.Type`	`relevancyEnablerGenusType`	a relevancy enabler genus type
Return	`osid.ontology.rules.RelevancyEnablerList`		the returned `RelevancyEnabler` list
Errors	NULL_ARGUMENT		`relevancyEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancyEnablersByRecordType
Description	Gets a `RelevancyEnablerList` containing the given relevancy enabler record `Type.` In plenary mode, the returned list contains all known relevancy enablers or an error results. Otherwise, the returned list may contain only those relevancy enablers that are accessible through this session. In active mode, relevancy enablers are returned that are currently active. In any status mode, active and inactive relevancy enablers are returned.
Parameters	`osid.type.Type`	`relevancyEnablerRecordType`	a relevancy enabler record type
Return	`osid.ontology.rules.RelevancyEnablerList`		the returned `RelevancyEnabler` list
Errors	NULL_ARGUMENT		`relevancyEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancyEnablersOnDate
Description	Gets a `RelevancyEnablerList` thate 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 relevancy enablers or an error results. Otherwise, the returned list may contain only those relevancy enablers that are accessible through this session. In active mode, relevancy enablers are returned that are currently active. In any status mode, active and inactive relevancy enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.ontology.rules.RelevancyEnablerList`		the returned `RelevancyEnabler` 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	getRelevancyEnablersOnDateWithAgent
Description	Gets a `RelevancyEnablerList` thate 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 relevancy enablers or an error results. Otherwise, the returned list may contain only those relevancy enablers that are accessible through this session. In active mode, relevancy enablers are returned that are currently active. In any status mode, active and inactive relevancy 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.ontology.rules.RelevancyEnablerList`		the returned `RelevancyEnabler` 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	getRelevancyEnablers
Description	Gets all `RelevancyEnablers.` In plenary mode, the returned list contains all known relevancy enablers or an error results. Otherwise, the returned list may contain only those relevancy enablers that are accessible through this session. In active mode, relevancy enablers are returned that are currently active. In any status mode, active and inactive relevancy enablers are returned.
Return	`osid.ontology.rules.RelevancyEnablerList`		the returned `RelevancyEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.