public interface ValueEnablerQuerySession extends OsidSession
This session provides methods for searching among ValueEnabler
objects. The search query is constructed using the
ValueEnablerQuery.
This session defines views that offer differing behaviors for searching.
Value enablers may have a query record indicated by their respective
record types. The query record is accessed via the
ValueEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchValueEnablers()
Tests if this user can perform
ValueEnabler lookups. |
Configuration |
getConfiguration()
Gets the
Configuration associated with this session. |
Id |
getConfigurationId()
Gets the
Configuration Id associated
with this session. |
ValueEnablerQuery |
getValueEnablerQuery()
Gets a value enabler query.
|
ValueEnablerList |
getValueEnablersByQuery(ValueEnablerQuery valueEnablerQuery)
Gets a list of
ValueEnablers matching the given value
enabler query. |
void |
useFederatedConfigurationView()
Federates the view for methods in this session.
|
void |
useIsolatedConfigurationView()
Isolates the view for methods in this session.
|
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 canSearchValueEnablers()
ValueEnabler
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 not offer lookup operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedConfigurationView()
mandatory
- This method is must be implemented. void useIsolatedConfigurationView()
mandatory
- This method is must be implemented. ValueEnablerQuery getValueEnablerQuery()
mandatory
- This method must be implemented. ValueEnablerList getValueEnablersByQuery(ValueEnablerQuery valueEnablerQuery) throws OperationFailedException, PermissionDeniedException
ValueEnablers
matching the given value
enabler query.valueEnablerQuery
- the value enabler query ValueEnablerList
NullArgumentException
- valueEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- valueEnablerQuery
is not of this servicemandatory
- This method must be implemented.