public interface RelevancyEnablerLookupSession extends OsidSession
This session provides methods for retrieving RelevancyEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
RelevancyEnablers
with the
RelevancyEnablerAdminSession.
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 useFederatedDistributorView()
and
useIsolatedDistributorView()
behave as a radio group and one
should be selected before invoking the methods in this session.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupRelevancyEnablers()
Tests if this user can perform
RelevancyEnablers
lookups. |
Ontology |
getOntology()
Gets the
Ontology associated with this session. |
Id |
getOntologyId()
Gets the
Ontology Id associated with
this session. |
RelevancyEnabler |
getRelevancyEnabler(Id relevancyEnablerId)
Gets the
RelevancyEnabler specified by its Id. |
RelevancyEnablerList |
getRelevancyEnablers()
Gets all
RelevancyEnablers. |
RelevancyEnablerList |
getRelevancyEnablersByGenusType(Type relevancyEnablerGenusType)
Gets a
RelevancyEnablerList corresponding to the given
relevancy enabler genus Type which does not include
relevancy enablers of genus types derived from the specified
Type. |
RelevancyEnablerList |
getRelevancyEnablersByIds(IdList relevancyEnablerIds)
Gets a
RelevancyEnablerList corresponding to the given
IdList. |
RelevancyEnablerList |
getRelevancyEnablersByParentGenusType(Type relevancyEnablerGenusType)
Gets a
RelevancyEnablerList corresponding to the given
relevancy enabler genus Type and include any additional
relevancy enablers with genus types derived from the specified
Type. |
RelevancyEnablerList |
getRelevancyEnablersByRecordType(Type relevancyEnablerRecordType)
Gets a
RelevancyEnablerList containing the given
relevancy enabler record Type. |
RelevancyEnablerList |
getRelevancyEnablersOnDate(DateTime from,
DateTime to)
Gets a
RelevancyEnablerList thate are effective for the
entire given date range inclusive but not confined to the date range
for any agent. |
RelevancyEnablerList |
getRelevancyEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
RelevancyEnablerList thate are effective for the
entire given date range inclusive but not confined to the date range
and evaluated against the given agent. |
void |
useActiveRelevancyEnablerView()
Only active relevancy enablers are returned by methods in this
session.
|
void |
useAnyStatusRelevancyEnablerView()
All active and inactive relevancy enablers are returned by methods in
this session.
|
void |
useComparativeRelevancyEnablerView()
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 |
usePlenaryRelevancyEnablerView()
A complete view of the
RelevancyEnabler 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.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupRelevancyEnablers()
RelevancyEnablers
lookups. A return of true does not guarantee successful authorization.
A return of false indicates that it is known all 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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeRelevancyEnablerView()
mandatory
- This method is must be implemented. void usePlenaryRelevancyEnablerView()
RelevancyEnabler
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 useActiveRelevancyEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusRelevancyEnablerView()
mandatory
- This method is must be implemented. RelevancyEnabler getRelevancyEnabler(Id relevancyEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RelevancyEnabler
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
RelevancyEnabler
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a RelevancyEnabler
and retained for
compatibility.
In active mode, relevancy enablers are returned that are currently
active. In any status mode, active and inactive relevancy enablers are
returned.relevancyEnablerId
- Id
of the
RelevancyEnabler
NotFoundException
- relevancyEnablerId
not foundNullArgumentException
- relevancyEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RelevancyEnablerList getRelevancyEnablersByIds(IdList relevancyEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
RelevancyEnablerList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
relevancy enablers 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 RelevancyEnablers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, relevancy enablers are returned that are currently
active. In any status mode, active and inactive relevancy enablers are
returned.relevancyEnablerIds
- the list of Ids
to retrieve RelevancyEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
- relevancyEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelevancyEnablerList getRelevancyEnablersByGenusType(Type relevancyEnablerGenusType) throws OperationFailedException, PermissionDeniedException
RelevancyEnablerList
corresponding to the given
relevancy enabler genus Type
which does not include
relevancy enablers of genus types derived from the specified
Type.
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.relevancyEnablerGenusType
- a relevancy enabler genus type RelevancyEnabler
listNullArgumentException
-
relevancyEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelevancyEnablerList getRelevancyEnablersByParentGenusType(Type relevancyEnablerGenusType) throws OperationFailedException, PermissionDeniedException
RelevancyEnablerList
corresponding to the given
relevancy enabler genus Type
and include any additional
relevancy enablers with genus types derived from the specified
Type.
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.relevancyEnablerGenusType
- a relevancy enabler genus type RelevancyEnabler
listNullArgumentException
-
relevancyEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelevancyEnablerList getRelevancyEnablersByRecordType(Type relevancyEnablerRecordType) throws OperationFailedException, PermissionDeniedException
RelevancyEnablerList
containing the given
relevancy enabler record Type.
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.relevancyEnablerRecordType
- a relevancy enabler record type RelevancyEnabler
listNullArgumentException
-
relevancyEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelevancyEnablerList getRelevancyEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
RelevancyEnablerList
thate are effective for the
entire given date range inclusive but not confined to the date range
for any agent.
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.from
- a start dateto
- an end date RelevancyEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelevancyEnablerList getRelevancyEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
RelevancyEnablerList
thate are effective for the
entire given date range inclusive but not confined to the date range
and evaluated against the given agent.
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.agentId
- an agent Id
from
- a start dateto
- an end date RelevancyEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- agentId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelevancyEnablerList getRelevancyEnablers() throws OperationFailedException, PermissionDeniedException
RelevancyEnablers.
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. RelevancyEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.