public interface DemographicEnablerQuerySession extends OsidSession
This session provides methods for searching among
DemographicEnabler
objects. The search query is constructed using
the DemographicEnablerQuery.
This session defines views that offer differing behaviors for searching.
Demographic enablers may have a query record indicated by their
respective record types. The query record is accessed via the
DemographicEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchDemographicEnablers()
Tests if this user can perform
DemographicEnabler
lookups. |
Bin |
getBin()
Gets the
Bin associated with this session. |
Id |
getBinId()
Gets the
Bin Id associated with this
session. |
DemographicEnablerQuery |
getDemographicEnablerQuery()
Gets a demographic enabler query.
|
DemographicEnablerList |
getDemographicEnablersByQuery(DemographicEnablerQuery demographicEnablerQuery)
Gets a list of
DemographicEnablers matching the given
demographic enabler query. |
void |
useFederatedBinView()
Federates the view for methods in this session.
|
void |
useIsolatedBinView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBinId()
Bin
Id
associated with this
session. Bin Id
associated with this sessionmandatory
- This method must be implemented. Bin getBin() throws OperationFailedException, PermissionDeniedException
Bin
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchDemographicEnablers()
DemographicEnabler
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 useFederatedBinView()
mandatory
- This method is must be implemented. void useIsolatedBinView()
mandatory
- This method is must be implemented. DemographicEnablerQuery getDemographicEnablerQuery()
mandatory
- This method must be implemented. DemographicEnablerList getDemographicEnablersByQuery(DemographicEnablerQuery demographicEnablerQuery) throws OperationFailedException, PermissionDeniedException
DemographicEnablers
matching the given
demographic enabler query.demographicEnablerQuery
- the demographic enabler query DemographicEnablerList
NullArgumentException
- demographicEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- demographicEnablerQuery
is not of this servicemandatory
- This method must be implemented.