public interface DemographicSmartBinSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
bins. A DemographicQuery
can be retrieved from this session
and mapped to this Bin
to create a virtual collection of
demographics. The demographic may be sequenced using the
DemographicSearchOrder
from this session.
This Bin
has a default query that matches any
demographic and a default search order that specifies no sequencing. The
queries may be examined using a DemographicQueryInspector.
The query may be modified by converting the inspector back to a
DemographicQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyDemographicQuery(DemographicQuery demographicQuery)
Applies a demographic query to this bin.
|
void |
applyDemographicSequencing(DemographicSearchOrder demographicSearchOrder)
Applies a demographic search order to this bin.
|
boolean |
canManageSmartBins()
Tests if this user can manage smart bins.
|
Bin |
getBin()
Gets the
Bin associated with this session. |
Id |
getBinId()
Gets the
Bin Id associated with this
session. |
DemographicQuery |
getDemographicQuery()
Gets a demographic query.
|
DemographicQuery |
getDemographicQueryFromInspector(DemographicQueryInspector demographicQueryInspector)
Gets a demographic query from an inspector.
|
DemographicSearchOrder |
getDemographicSearchOrder()
Gets a demographic search order.
|
DemographicQueryInspector |
inspectDemographicQuery()
Gets a demographic query inspector for this bin.
|
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 canManageSmartBins()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart bin management is not
authorized, true
otherwisemandatory
- This method must be implemented. DemographicQuery getDemographicQuery()
mandatory
- This method must be implemented. DemographicSearchOrder getDemographicSearchOrder()
mandatory
- This method must be implemented. void applyDemographicQuery(DemographicQuery demographicQuery) throws OperationFailedException, PermissionDeniedException
demographicQuery
- the demographic queryNullArgumentException
- demographicQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- demographicQuery
not of this servicemandatory
- This method must be implemented. DemographicQueryInspector inspectDemographicQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyDemographicSequencing(DemographicSearchOrder demographicSearchOrder) throws OperationFailedException, PermissionDeniedException
demographicSearchOrder
- the demographic search orderNullArgumentException
- demographicSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- demographicSearchOrder
not of this servicemandatory
- This method must be implemented. DemographicQuery getDemographicQueryFromInspector(DemographicQueryInspector demographicQueryInspector)
demographicQueryInspector
- a demographic query inspectorNullArgumentException
-
demographicQueryInspector
is null
UnsupportedException
- demographicQueryInspector
is not of this servicemandatory
- This method must be implemented.