OSID Logo
OSID Specifications
ontology rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.rules.RelevancyEnablerLookupSession
Implementsosid.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.

MethodgetOntologyId
Description

Gets the Ontology Id associated with this session.

Returnosid.id.Idthe Ontology Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetOntology
Description

Gets the Ontology associated with this session.

Returnosid.ontology.Ontologythe ontology
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupRelevancyEnablers
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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeRelevancyEnablerView
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.
MethodusePlenaryRelevancyEnablerView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedOntologyView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedOntologyView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this ontology only.

CompliancemandatoryThis method is must be implemented.
MethoduseActiveRelevancyEnablerView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusRelevancyEnablerView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetRelevancyEnabler
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.

Parametersosid.id.IdrelevancyEnablerId Id of the RelevancyEnabler
Returnosid.ontology.rules.RelevancyEnablerthe relevancy enabler
ErrorsNOT_FOUND relevancyEnablerId not found
NULL_ARGUMENT relevancyEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetRelevancyEnablersByIds
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.

Parametersosid.id.IdListrelevancyEnablerIdsthe list of Ids to retrieve
Returnosid.ontology.rules.RelevancyEnablerListthe returned RelevancyEnabler list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT relevancyEnablerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRelevancyEnablersByGenusType
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.

Parametersosid.type.TyperelevancyEnablerGenusTypea relevancy enabler genus type
Returnosid.ontology.rules.RelevancyEnablerListthe returned RelevancyEnabler list
ErrorsNULL_ARGUMENT relevancyEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRelevancyEnablersByParentGenusType
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.

Parametersosid.type.TyperelevancyEnablerGenusTypea relevancy enabler genus type
Returnosid.ontology.rules.RelevancyEnablerListthe returned RelevancyEnabler list
ErrorsNULL_ARGUMENT relevancyEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRelevancyEnablersByRecordType
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.

Parametersosid.type.TyperelevancyEnablerRecordTypea relevancy enabler record type
Returnosid.ontology.rules.RelevancyEnablerListthe returned RelevancyEnabler list
ErrorsNULL_ARGUMENT relevancyEnablerRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRelevancyEnablersOnDate
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.

Parametersosid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.ontology.rules.RelevancyEnablerListthe returned RelevancyEnabler 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.
MethodgetRelevancyEnablersOnDateWithAgent
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.

Parametersosid.id.IdagentIdan agent Id
osid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.ontology.rules.RelevancyEnablerListthe returned RelevancyEnabler 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.
MethodgetRelevancyEnablers
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.

Returnosid.ontology.rules.RelevancyEnablerListthe returned RelevancyEnabler list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.