public interface RelevancyLookupSession extends OsidSession
This session provides methods for examining subject relevancy.
This session defines views that offer differing behaviors when retrieving multiple objects.
RelevancyAdminSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupRelevancies()
Tests if this user can lookup subject relevancies.
|
Ontology |
getOntology()
Gets the
Ontology associated with this session. |
Id |
getOntologyId()
Gets the
Ontology Id associated with
this session. |
RelevancyList |
getRelevancies()
Gets all relevancies.
|
RelevancyList |
getRelevanciesByGenusType(Type relevancyGenusType)
Gets the relevancies for the given relevancy and genus type.
|
RelevancyList |
getRelevanciesByGenusTypeForMappedId(Id id,
Type relevancyGenusType)
Gets the
Relevancy elements mapped to an Id
of the given relevancy genus Type which
includes derived genus Types. |
RelevancyList |
getRelevanciesByGenusTypeForMappedIdOnDate(Id id,
Type relevancyGenusType,
DateTime from,
DateTime to)
Gets a
RelevancyList of the given genus type for the
given mapped Id effective during the entire given date
range inclusive but not confined to the date range. |
RelevancyList |
getRelevanciesByGenusTypeForSubject(Id subjectId,
Type relevancyGenusType)
Gets the
Relevancy mapped to a subject Id
and relevancy genus Type. |
RelevancyList |
getRelevanciesByGenusTypeForSubjectAndMappedId(Id subjectId,
Id id,
Type relevancyGenusType)
Gets the
Relevancy of the given genus type and mapped
to a subject and mapped Id. |
RelevancyList |
getRelevanciesByGenusTypeForSubjectAndMappedIdOnDate(Id subjectId,
Id id,
Type relevancyGenusType,
DateTime from,
DateTime to)
Gets a
RelevancyList of the given genus type and
related to the given subject and mapped Id effective
during the entire given date range inclusive but not confined to the
date range. |
RelevancyList |
getRelevanciesByGenusTypeForSubjectOnDate(Id subjectId,
Type relevancyGenusType,
DateTime from,
DateTime to)
Gets a
RelevancyList of the given genus type for the
given subject effective during the entire given date range inclusive
but not confined to the date range. |
RelevancyList |
getRelevanciesByGenusTypeOnDate(Type relevancyGenusType,
DateTime from,
DateTime to)
Gets a
RelevancyList of the given genus type and
effective during the entire given date range inclusive but not
confined to the date range. |
RelevancyList |
getRelevanciesByIds(IdList relevancyIds)
Gets a
RelevancyList corresponding to the given
IdList. |
RelevancyList |
getRelevanciesByParentGenusType(Type relevancyGenusType)
Gets the relevancies for the given relevancy genus type and include
any relevancies with a genus type derived from the specified genus
type.
|
RelevancyList |
getRelevanciesByRecordType(Type relevancyRecordType)
Gets a
RelevancyList containing the given relevancy
record Type. |
RelevancyList |
getRelevanciesForMappedId(Id id)
Gets the
Relevancy elements mapped to an Id. |
RelevancyList |
getRelevanciesForMappedIdOnDate(Id id,
DateTime from,
DateTime to)
Gets a
RelevancyList for the given mapped Id
effective during the entire given date range inclusive but not
confined to the date range. |
RelevancyList |
getRelevanciesForMappedIds(IdList ids)
Gets the relevancies for the given mapped
Ids. |
RelevancyList |
getRelevanciesForSubject(Id subjectId)
Gets the
Relevancy mapped to a subject Id. |
RelevancyList |
getRelevanciesForSubjectAndMappedId(Id subjectId,
Id id)
Gets the
Relevancy mapped to a subject and mapped
Id. |
RelevancyList |
getRelevanciesForSubjectAndMappedIdOnDate(Id subjectId,
Id id,
DateTime from,
DateTime to)
Gets a
RelevancyList for the given subject and mapped
Id effective during the entire given date range
inclusive but not confined to the date range. |
RelevancyList |
getRelevanciesForSubjectOnDate(Id subjectId,
DateTime from,
DateTime to)
Gets a
RelevancyList for the given subject effective
during the entire given date range inclusive but not confined to the
date range. |
RelevancyList |
getRelevanciesForSubjects(IdList subjectIds)
Gets the relevancies for the given subject
Ids. |
RelevancyList |
getRelevanciesOnDate(DateTime from,
DateTime to)
Gets a
RelevancyList effective during the entire given
date range inclusive but not confined to the date range. |
Relevancy |
getRelevancy(Id relevancyId)
Gets the
Relevancy specified by its Id. |
void |
useAnyEffectiveRelevancyView()
Both effective and ineffective relavcnies are returned.
|
void |
useComparativeRelevancyView()
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 |
useEffectiveRelevancyView()
The returns from the lookup methods return only effetive relevancies.
|
void |
useFederatedOntologyView()
Federates the view for methods in this session.
|
void |
useIsolatedOntologyView()
Isolates the view for methods in this session.
|
void |
usePlenaryRelevancyView()
A complete view of the
Relevancy returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOntologyId()
Ontology
Id
associated with
this session. Ontology Id
associated with this sessionmandatory
- This method must be implemented. Ontology getOntology() throws OperationFailedException, PermissionDeniedException
Ontology
associated with this session. Ontology
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupRelevancies()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeRelevancyView()
mandatory
- This method is must be implemented. void usePlenaryRelevancyView()
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.mandatory
- This method is must be implemented. void useFederatedOntologyView()
mandatory
- This method is must be implemented. void useIsolatedOntologyView()
mandatory
- This method is must be implemented. void useEffectiveRelevancyView()
mandatory
- This method is must be implemented. void useAnyEffectiveRelevancyView()
mandatory
- This method is must be implemented. Relevancy getRelevancy(Id relevancyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Relevancy
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Relevancy
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a Relevancy
and retained for compatibility.
In effective mode, relevancies are returned that are currently
effective. In any effective mode, effective relevancies and those
currently expired are returned.relevancyId
- Id
of the Relevancy
NotFoundException
- relevancyId
not
foundNullArgumentException
- relevancyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RelevancyList getRelevanciesByIds(IdList relevancyIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
RelevancyList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
relevancies 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 relevancies may be omitted from the list and may present
the elements in any order including returning a unique set.
In effective mode, relevancies are returned that are currently
effective. In any effective mode, effective relevancies and those
currently expired are returned.relevancyIds
- the list of Ids
to retrieve Relevancy list
NotFoundException
- an Id was
not foundNullArgumentException
- relevancyIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelevancyList getRelevanciesByGenusType(Type relevancyGenusType) throws OperationFailedException, PermissionDeniedException
relevancyGenusType
- relevancy genus typeNullArgumentException
- relevancyGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RelevancyList getRelevanciesByParentGenusType(Type relevancyGenusType) throws OperationFailedException, PermissionDeniedException
relevancyGenusType
- relevancy genus typeNullArgumentException
- relevancyGenusTYpe
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RelevancyList getRelevanciesByRecordType(Type relevancyRecordType) throws OperationFailedException, PermissionDeniedException
RelevancyList
containing the given relevancy
record Type.
In plenary mode, the returned list contains all known
relevancies or an error results. Otherwise, the returned list may
contain only those relevancies that are accessible through this
session.
In effective mode, relevancies are returned that are currently
effective. In any effective mode, effective relevancies and those
currently expired are returned.relevancyRecordType
- a relevancy record typeNullArgumentException
- relevancyRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelevancyList getRelevanciesOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
RelevancyList
effective during the entire given
date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known relevancies or
an error results. Otherwise, the returned list may contain only those
relevancies that are accessible through this session.
In effective mode, relevancies are returned that are currently
effective. In any effective mode, effective relevancies and those
currently expired are returned.from
- a starting dateto
- an ending dateInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelevancyList getRelevanciesByGenusTypeOnDate(Type relevancyGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
RelevancyList
of the given genus type and
effective during the entire given date range inclusive but not
confined to the date range.
In plenary mode, the returned list contains all known relevancies or
an error results. Otherwise, the returned list may contain only those
relevancies that are accessible through this session.
In effective mode, relevancies are returned that are currently
effective. In any effective mode, effective relevancies and those
currently expired are returned.relevancyGenusType
- relevancy genus typefrom
- a starting dateto
- an ending dateInvalidArgumentException
- from
is
greater than to
NullArgumentException
- relevancyGenusType,
from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelevancyList getRelevanciesForSubject(Id subjectId) throws OperationFailedException, PermissionDeniedException
Relevancy
mapped to a subject Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Relevancy
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a Relevancy
and retained for compatibility.
In effective mode, relevancies are returned that are currently
effective. In any effective mode, effective relevancies and those
currently expired are returned.subjectId
- the subject Id
NullArgumentException
- subjectId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RelevancyList getRelevanciesForSubjectOnDate(Id subjectId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
RelevancyList
for the given subject effective
during the entire given date range inclusive but not confined to the
date range.
In plenary mode, the returned list contains all known relevancies or
an error results. Otherwise, the returned list may contain only those
relevancies that are accessible through this session.
In effective mode, relevancies are returned that are currently
effective. In any effective mode, effective relevancies and those
currently expired are returned.subjectId
- the subject Id
from
- a starting dateto
- an ending dateInvalidArgumentException
- from
is
greater than to
NullArgumentException
- subjectId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelevancyList getRelevanciesByGenusTypeForSubject(Id subjectId, Type relevancyGenusType) throws OperationFailedException, PermissionDeniedException
Relevancy
mapped to a subject Id
and relevancy genus Type.
Genus Types
derived from the given genus Typ
e are
included.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Relevancy
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to a
Relevancy
and retained for compatibility.
In effective mode, relevancies are returned that are currently
effective. In any effective mode, effective relevancies and those
currently expired are returned.subjectId
- the subject Id
relevancyGenusType
- relevancy genus typeNullArgumentException
- subjectId
or
relevancyGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RelevancyList getRelevanciesByGenusTypeForSubjectOnDate(Id subjectId, Type relevancyGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
RelevancyList
of the given genus type for the
given subject effective during the entire given date range inclusive
but not confined to the date range.
In plenary mode, the returned list contains all known relevancies or
an error results. Otherwise, the returned list may contain only those
relevancies that are accessible through this session.
In effective mode, relevancies are returned that are currently
effective. In any effective mode, effective relevancies and those
currently expired are returned.subjectId
- the subject Id
relevancyGenusType
- relevancy genus typefrom
- a starting dateto
- an ending dateInvalidArgumentException
- from
is
greater than to
NullArgumentException
- subjectId,
relevancyGenusType, from,
or to
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelevancyList getRelevanciesForSubjects(IdList subjectIds) throws OperationFailedException, PermissionDeniedException
Ids.
In plenary mode, the returned list contains all of the relevancies
specified in the subject Id
list, in the order of the
list, including duplicates, or an error results if a relevancy
Id
in the supplied list is not found or inaccessible.
Otherwise, inaccessible relevancies may be omitted from the list and
may present the elements in any order including returning a unique
set.
In effective mode, relevancies are returned that are currently
effective. In any effective mode, effective relevancies and those
currently expired are returned.subjectIds
- list of subject Ids
NullArgumentException
- subjectIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RelevancyList getRelevanciesForMappedId(Id id) throws OperationFailedException, PermissionDeniedException
Relevancy
elements mapped to an Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Relevancy
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a Relevancy
and retained for compatibility.
In effective mode, relevancies are returned that are currently
effective. In any effective mode, effective relevancies and those
currently expired are returned.id
- an Id
NullArgumentException
- id
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RelevancyList getRelevanciesForMappedIdOnDate(Id id, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
RelevancyList
for the given mapped Id
effective during the entire given date range inclusive but not
confined to the date range.
In plenary mode, the returned list contains all known relevancies or
an error results. Otherwise, the returned list may contain only those
relevancies that are accessible through this session.
In effective mode, relevancies are returned that are currently
effective. In any effective mode, effective relevancies and those
currently expired are returned.id
- an Id
from
- a starting dateto
- an ending dateInvalidArgumentException
- from
is
greater than to
NullArgumentException
- id, from,
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelevancyList getRelevanciesByGenusTypeForMappedId(Id id, Type relevancyGenusType) throws OperationFailedException, PermissionDeniedException
Relevancy
elements mapped to an Id
of the given relevancy genus Type
which
includes derived genus Types.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Relevancy
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a Relevancy
and retained for compatibility.
In effective mode, relevancies are returned that are currently
effective. In any effective mode, effective relevancies and those
currently expired are returned.id
- an Id
relevancyGenusType
- relevancy genus typeNullArgumentException
- id
or
relevancyGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RelevancyList getRelevanciesByGenusTypeForMappedIdOnDate(Id id, Type relevancyGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
RelevancyList
of the given genus type for the
given mapped Id
effective during the entire given date
range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known relevancies or
an error results. Otherwise, the returned list may contain only those
relevancies that are accessible through this session.
In effective mode, relevancies are returned that are currently
effective. In any effective mode, effective relevancies and those
currently expired are returned.id
- an Id
relevancyGenusType
- relevancy genus typefrom
- a starting dateto
- an ending dateInvalidArgumentException
- from
is
greater than to
NullArgumentException
- id, relevancyGenusType,
from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelevancyList getRelevanciesForMappedIds(IdList ids) throws OperationFailedException, PermissionDeniedException
Ids.
In plenary mode, the returned list contains all of the
relevancies mapped to the Id
or an error results if an
Id
in the supplied list is not found or inaccessible.
Otherwise, inaccessible relevancies may be omitted from the list and
may present the elements in any order including returning a unique
set.
In effective mode, relevancies are returned that are currently
effective. In any effective mode, effective relevancies and those
currently expired are returned.ids
- a list of Ids
NullArgumentException
- ids
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RelevancyList getRelevanciesForSubjectAndMappedId(Id subjectId, Id id) throws OperationFailedException, PermissionDeniedException
Relevancy
mapped to a subject and mapped
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Relevancy
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a Relevancy
and retained for compatibility.
In effective mode, relevancies are returned that are currently
effective. In any effective mode, effective relevancies and those
currently expired are returned.subjectId
- the subject Id
id
- the mapped Id
NullArgumentException
- subjectId
or
id
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RelevancyList getRelevanciesForSubjectAndMappedIdOnDate(Id subjectId, Id id, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
RelevancyList
for the given subject and mapped
Id
effective during the entire given date range
inclusive but not confined to the date range.
In plenary mode, the returned list contains all known relevancies or
an error results. Otherwise, the returned list may contain only those
relevancies that are accessible through this session.
In effective mode, relevancies are returned that are currently
effective. In any effective mode, effective relevancies and those
currently expired are returned.subjectId
- the subject Id
id
- the mapped Id
from
- a starting dateto
- an ending dateInvalidArgumentException
- from
is
greater than to
NullArgumentException
- subjectId, id, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelevancyList getRelevanciesByGenusTypeForSubjectAndMappedId(Id subjectId, Id id, Type relevancyGenusType) throws OperationFailedException, PermissionDeniedException
Relevancy
of the given genus type and mapped
to a subject and mapped Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Relevancy
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a Relevancy
and retained for compatibility.
In effective mode, relevancies are returned that are currently
effective. In any effective mode, effective relevancies and those
currently expired are returned.subjectId
- the subject Id
id
- the mapped Id
relevancyGenusType
- relevancy genus typeNullArgumentException
- subjectId, id
,
or relevancyGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RelevancyList getRelevanciesByGenusTypeForSubjectAndMappedIdOnDate(Id subjectId, Id id, Type relevancyGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
RelevancyList
of the given genus type and
related to the given subject and mapped Id
effective
during the entire given date range inclusive but not confined to the
date range.
In plenary mode, the returned list contains all known relevancies or
an error results. Otherwise, the returned list may contain only those
relevancies that are accessible through this session.
In effective mode, relevancies are returned that are currently
effective. In any effective mode, effective relevancies and those
currently expired are returned.subjectId
- the subject Id
id
- the mapped Id
relevancyGenusType
- relevancy genus typefrom
- a starting dateto
- an ending dateInvalidArgumentException
- from
is
greater than to
NullArgumentException
- subjectId, id,
relevancyGenusTYpe, from,
or to
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelevancyList getRelevancies() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented.