public interface RelevancyOntologySession extends OsidSession
This session provides methods to retrieve Relevancy
to
Ontology
mappings. A Relevancy
may appear in
multiple Ontologies.
Each Ontology
may have
its own authorizations governing who is allowed to look at it.
This lookup session defines two views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupRelevancyOntologyMappings()
Tests if this user can perform lookups of relevancy/ontology mappings.
|
OntologyList |
getOntologiesByRelevancy(Id relevancyId)
Gets the list of
Ontologies mapped to a
Relevancy. |
IdList |
getOntologyIdsByRelevancy(Id relevancyId)
Gets the list of
Ontology Ids mapped to
a Relevancy |
RelevancyList |
getRelevanciesByOntologies(IdList ontologyIds)
Gets the list of
Relevancies corresponding to a list of
Ontologies. |
RelevancyList |
getRelevanciesByOntology(Id ontologyId)
Gets the list of
Relevancies associated with an
Ontology. |
IdList |
getRelevancyIdsByOntologies(IdList ontologyIds)
Gets the list of
Relevancy Ids corresponding to a list
of Ontologies. |
IdList |
getRelevancyIdsByOntology(Id ontologyId)
Gets the list of
Relevancy Ids
associated with an Ontology. |
void |
useComparativeOntologyView()
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 |
usePlenaryOntologyView()
A complete view of the
Relevancy and Ontology
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupRelevancyOntologyMappings()
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 useComparativeOntologyView()
mandatory
- This method is must be implemented. void usePlenaryOntologyView()
Relevancy
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 getRelevancyIdsByOntology(Id ontologyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Relevancy
Ids
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. RelevancyList getRelevanciesByOntology(Id ontologyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Relevancies
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. IdList getRelevancyIdsByOntologies(IdList ontologyIds) throws OperationFailedException, PermissionDeniedException
Relevancy 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. RelevancyList getRelevanciesByOntologies(IdList ontologyIds) throws OperationFailedException, PermissionDeniedException
Relevancies
corresponding to a list of
Ontologies.
ontologyIds
- list of ontology Ids
NullArgumentException
- ontologyIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getOntologyIdsByRelevancy(Id relevancyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Ontology
Ids
mapped to
a Relevancy
relevancyId
- Id
of a Relevancy
Ids
NotFoundException
- relevancyId
is not
foundNullArgumentException
- relevancyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OntologyList getOntologiesByRelevancy(Id relevancyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Ontologies
mapped to a
Relevancy.
relevancyId
- Id
of a Relevancy
NotFoundException
- relevancyId
is not
foundNullArgumentException
- relevancyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.