public interface RelevancyEnablerOntologySession extends OsidSession
This session provides methods to retrieve RelevancyEnabler
to Ontology
mappings. A RelevancyEnabler
may appear in multiple Ontology
objects. Each
ontology may have its own authorizations governing who is allowed to look
at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupRelevancyEnablerOntologyMappings()
Tests if this user can perform lookups of relevancy enabler/ontology
mappings.
|
OntologyList |
getOntologiesByRelevancyEnabler(Id relevancyEnablerId)
Gets the
Ontologies mapped to a
RelevancyEnabler. |
IdList |
getOntologyIdsByRelevancyEnabler(Id relevancyEnablerId)
Gets the
Ontology Ids mapped to a
RelevancyEnabler. |
IdList |
getRelevancyEnablerIdsByOntologies(IdList ontologyIds)
Gets the list of
RelevancyEnabler Ids corresponding to
a list of Ontologies. |
IdList |
getRelevancyEnablerIdsByOntology(Id ontologyId)
Gets the list of
RelevancyEnablerIds associated with an
Ontology. |
RelevancyEnablerList |
getRelevancyEnablersByOntologies(IdList ontologyIds)
Gets the list of relevancy enablers corresponding to a list of
Ontologies. |
RelevancyEnablerList |
getRelevancyEnablersByOntology(Id ontologyId)
Gets the list of relevancy enablers associated with an
Ontology. |
void |
useComparativeRelevancyEnablerOntologyView()
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 |
usePlenaryRelevancyEnablerOntologyView()
A complete view of the
RelevancyEnabler and
Ontology returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupRelevancyEnablerOntologyMappings()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeRelevancyEnablerOntologyView()
mandatory
- This method is must be implemented. void usePlenaryRelevancyEnablerOntologyView()
RelevancyEnabler
and
Ontology
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.mandatory
- This method is must be implemented. IdList getRelevancyEnablerIdsByOntology(Id ontologyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RelevancyEnablerIds
associated with an
Ontology.
ontologyId
- Id
of the Ontology
Ids
NotFoundException
- ontologyId
is not
foundNullArgumentException
- ontologyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelevancyEnablerList getRelevancyEnablersByOntology(Id ontologyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Ontology.
ontologyId
- Id
of the Ontology
NotFoundException
- ontologyId
is not
foundNullArgumentException
- ontologyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getRelevancyEnablerIdsByOntologies(IdList ontologyIds) throws OperationFailedException, PermissionDeniedException
RelevancyEnabler Ids
corresponding to
a list of Ontologies.
ontologyIds
- list of ontology Ids
Ids
NullArgumentException
- ontologyIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelevancyEnablerList getRelevancyEnablersByOntologies(IdList ontologyIds) throws OperationFailedException, PermissionDeniedException
Ontologies.
ontologyIds
- list of ontology Ids
NullArgumentException
- ontologyIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getOntologyIdsByRelevancyEnabler(Id relevancyEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Ontology
Ids
mapped to a
RelevancyEnabler.
relevancyEnablerId
- Id
of a
RelevancyEnabler
NotFoundException
- relevancyEnablerId
is not foundNullArgumentException
- relevancyEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OntologyList getOntologiesByRelevancyEnabler(Id relevancyEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Ontologies
mapped to a
RelevancyEnabler.
relevancyEnablerId
- Id
of a
RelevancyEnabler
NotFoundException
- relevancyEnablerId
is not foundNullArgumentException
- relevancyEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.