Interface | osid.ontology.rules.RelevancyEnablerLookupSession | ||
---|---|---|---|
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 | getOntologyId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Ontology Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getOntology | ||
Description |
Gets the | ||
Return | osid.ontology.Ontology | the ontology | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupRelevancyEnablers | ||
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 | 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 | ||
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 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 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 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 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 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 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 |
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 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 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 | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |