public interface ValueEnablerLookupSession extends OsidSession
This session provides methods for retrieving ValueEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
ValueEnablers
with the
ValueEnablerAdminSession.
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 |
canLookupValueEnablers()
Tests if this user can perform
ValueEnablers lookups. |
Configuration |
getConfiguration()
Gets the
Configuration associated with this session. |
Id |
getConfigurationId()
Gets the
Configuration Id associated
with this session. |
ValueEnabler |
getValueEnabler(Id valueEnablerId)
Gets the
ValueEnabler specified by its Id. |
ValueEnablerList |
getValueEnablers()
Gets all
ValueEnablers. |
ValueEnablerList |
getValueEnablersByGenusType(Type valueEnablerGenusType)
Gets a
ValueEnablerList corresponding to the given
value enabler genus Type which does not include value
enablers of genus types derived from the specified Type. |
ValueEnablerList |
getValueEnablersByIds(IdList valueEnablerIds)
Gets a
ValueEnablerList corresponding to the given
IdList. |
ValueEnablerList |
getValueEnablersByParentGenusType(Type valueEnablerGenusType)
Gets a
ValueEnablerList corresponding to the given
value enabler genus Type and include any additional
value enablers with genus types derived from the specified
Type. |
ValueEnablerList |
getValueEnablersByRecordType(Type valueEnablerRecordType)
Gets a
ValueEnablerList containing the given value
enabler record Type. |
ValueEnablerList |
getValueEnablersOnDate(DateTime from,
DateTime to)
Gets a
ValueEnablerList effective within the given date
range which are effective for the entire given date range inclusive
but not confined to the date range for any agent. |
ValueEnablerList |
getValueEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
ValueEnablerList effective within the given date
range which are effective for the entire given date range inclusive
but not confined to the date range and evaluated for the given agent. |
void |
useActiveValueEnablerView()
Only active value enablers are returned by methods in this session.
|
void |
useAnyStatusValueEnablerView()
All active and inactive value enablers are returned by methods in this
session.
|
void |
useComparativeValueEnablerView()
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 |
useFederatedConfigurationView()
Federates the view for methods in this session.
|
void |
useIsolatedConfigurationView()
Isolates the view for methods in this session.
|
void |
usePlenaryValueEnablerView()
A complete view of the
ValueEnabler returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getConfigurationId()
Configuration
Id
associated
with this session. Configuration Id
associated with this
sessionmandatory
- This method must be implemented. Configuration getConfiguration() throws OperationFailedException, PermissionDeniedException
Configuration
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupValueEnablers()
ValueEnablers
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 useComparativeValueEnablerView()
mandatory
- This method is must be implemented. void usePlenaryValueEnablerView()
ValueEnabler
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 useFederatedConfigurationView()
mandatory
- This method is must be implemented. void useIsolatedConfigurationView()
mandatory
- This method is must be implemented. void useActiveValueEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusValueEnablerView()
mandatory
- This method is must be implemented. ValueEnabler getValueEnabler(Id valueEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ValueEnabler
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
ValueEnabler
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a ValueEnabler
and retained for
compatibility.
In active mode, value enablers are returned that are currently active.
In any status mode, active and inactive value enablers are returned.valueEnablerId
- Id
of the ValueEnabler
NotFoundException
- valueEnablerId
not
foundNullArgumentException
- valueEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. ValueEnablerList getValueEnablersByIds(IdList valueEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ValueEnablerList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
value 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 ValueEnablers
may be omitted from the list
and may present the elements in any order including returning a unique
set.
In active mode, value enablers are returned that are currently active.
In any status mode, active and inactive value enablers are returned.valueEnablerIds
- the list of Ids
to retrieve ValueEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
- valueEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ValueEnablerList getValueEnablersByGenusType(Type valueEnablerGenusType) throws OperationFailedException, PermissionDeniedException
ValueEnablerList
corresponding to the given
value enabler genus Type
which does not include value
enablers of genus types derived from the specified Type.
In plenary mode, the returned list contains all known
value enablers or an error results. Otherwise, the returned list may
contain only those value enablers that are accessible through this
session.
In active mode, value enablers are returned that are currently active.
In any status mode, active and inactive value enablers are returned.valueEnablerGenusType
- a value enabler genus type ValueEnabler
listNullArgumentException
- valueEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ValueEnablerList getValueEnablersByParentGenusType(Type valueEnablerGenusType) throws OperationFailedException, PermissionDeniedException
ValueEnablerList
corresponding to the given
value enabler genus Type
and include any additional
value enablers with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
value enablers or an error results. Otherwise, the returned list may
contain only those value enablers that are accessible through this
session.
In active mode, value enablers are returned that are currently active.
In any status mode, active and inactive value enablers are returned.valueEnablerGenusType
- a value enabler genus type ValueEnabler
listNullArgumentException
- valueEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ValueEnablerList getValueEnablersByRecordType(Type valueEnablerRecordType) throws OperationFailedException, PermissionDeniedException
ValueEnablerList
containing the given value
enabler record Type.
In plenary mode, the returned list contains all known
value enablers or an error results. Otherwise, the returned list may
contain only those value enablers that are accessible through this
session.
In active mode, value enablers are returned that are currently active.
In any status mode, active and inactive value enablers are returned.valueEnablerRecordType
- a value enabler record type ValueEnabler
listNullArgumentException
- valueEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ValueEnablerList getValueEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ValueEnablerList
effective within the given date
range which 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 value enablers
or an error results. Otherwise, the returned list may contain only
those value enablers that are accessible through this session.
In active mode, value enablers are returned that are currently active.
In any status mode, active and inactive value enablers are returned.from
- a start dateto
- an end date ValueEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ValueEnablerList getValueEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ValueEnablerList
effective within the given date
range which are effective for the entire given date range inclusive
but not confined to the date range and evaluated for the given agent.
In plenary mode, the returned list contains all known value enablers
or an error results. Otherwise, the returned list may contain only
those value enablers that are accessible through this session.
In active mode, value enablers are returned that are currently active.
In any status mode, active and inactive value enablers are returned.agentId
- an agent Idfrom
- a start dateto
- an end date ValueEnabler
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. ValueEnablerList getValueEnablers() throws OperationFailedException, PermissionDeniedException
ValueEnablers.
In plenary mode, the returned list contains all known
value enablers or an error results. Otherwise, the returned list may
contain only those value enablers that are accessible through this
session.
In active mode, value enablers are returned that are currently active.
In any status mode, active and inactive value enablers are returned. ValueEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.