org.osid.ontology.rules

Interface RelevancyEnablerRuleLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface RelevancyEnablerRuleLookupSession
extends OsidSession

This session provides methods to retrieve RelevancyEnabler to Relevancy mappings. A Relevancy with multiple RelevancyEnablers means any positive rule evaluation across the enablers result in an effective Relevancy.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition
• isolated ontology view: All methods in this session operate, retrieve and pertain relevancy enablers defined explicitly in the current ontology
• federated ontology view: All 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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupRelevancyEnablerRule() Tests if this user can perform lookups of relevancy enabler/relevancy mappings.
Ontology	getOntology() Gets the Ontology associated with this session.
Id	getOntologyId() Gets the Ontology Id associated with this session.
RelevancyList	getRelevanciesForRelevancyEnabler(Id relevancyEnablerId) Gets the Relevancies mapped to a RelevancyEnabler.
IdList	getRelevancyEnablerIdsForRelevancy(Id relevancyId) Gets the RelevancyEnabler Id associated with a Relevancy.
RelevancyEnablerList	getRelevancyEnablersForRelevancy(Id relevancyId) Gets the RelevancyEnabler associated with a Relevancy.
IdList	getRelevancyIdsForRelevancyEnabler(Id relevancyEnablerId) Gets the Relevancy Ids mapped to a RelevancyEnabler.
void	useComparativeRelevancyEnablerRuleView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	useFederatedOntologyView() Federates the view for methods in this session.
void	useIsolatedOntologyView() Isolates the view for methods in this session.
void	usePlenaryRelevancyEnablerRuleView() A complete view of the RelevancyEnabler and Relevancy returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getOntologyId

Id getOntologyId()

Gets the Ontology Id associated with this session.

Returns:

the Ontology Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOntology

Ontology getOntology()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Ontology associated with this session.

Returns:

the ontology

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupRelevancyEnablerRule

boolean canLookupRelevancyEnablerRule()

Tests if this user can perform lookups of relevancy enabler/relevancy mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeRelevancyEnablerRuleView

void useComparativeRelevancyEnablerRuleView()

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.

usePlenaryRelevancyEnablerRuleView

void usePlenaryRelevancyEnablerRuleView()

A complete view of the RelevancyEnabler and Relevancy 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.

useFederatedOntologyView

void useFederatedOntologyView()

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.

useIsolatedOntologyView

void useIsolatedOntologyView()

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.

getRelevancyEnablerIdsForRelevancy

IdList getRelevancyEnablerIdsForRelevancy(Id relevancyId)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Gets the RelevancyEnabler Id associated with a Relevancy.

Parameters:

relevancyId - Id of the Relevancy

Returns:

the relevancy enabler Ids

Throws:

NotFoundException - relevancyId is not found

NullArgumentException - relevancyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRelevancyEnablersForRelevancy

RelevancyEnablerList getRelevancyEnablersForRelevancy(Id relevancyId)
                                                      throws NotFoundException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

Gets the RelevancyEnabler associated with a Relevancy.

Parameters:

relevancyId - Id of the Relevancy

Returns:

the relevancy enablers

Throws:

NotFoundException - relevancyId is not found

NullArgumentException - relevancyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRelevancyIdsForRelevancyEnabler

IdList getRelevancyIdsForRelevancyEnabler(Id relevancyEnablerId)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Gets the Relevancy Ids mapped to a RelevancyEnabler.

Parameters:

relevancyEnablerId - Id of a RelevancyEnabler

Returns:

list of relevancy Ids

Throws:

NotFoundException - relevancyEnablerId is not found

NullArgumentException - relevancyEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRelevanciesForRelevancyEnabler

RelevancyList getRelevanciesForRelevancyEnabler(Id relevancyEnablerId)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the Relevancies mapped to a RelevancyEnabler.

Parameters:

relevancyEnablerId - Id of a RelevancyEnabler

Returns:

list of relevancies

Throws:

NotFoundException - relevancyEnablerId is not found

NullArgumentException - relevancyEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.