public interface DemographicEnablerSmartBinSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
bins. A DemographicEnablerQuery
can be retrieved from this
session and mapped to this Bin
to create a virtual
collection of demographic enablers. The demographic enablers may be
sequenced using the DemographicEnablerSearchOrder
from this
session.
This Bin
has a default query that matches any
demographic enabler and a default search order that specifies no
sequencing. The queries may be examined using a
DemographicEnablerQueryInspector.
The query may be modified by
converting the inspector back to a DemographicEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyDemographicEnablerQuery(DemographicEnablerQuery demographicEnablerQuery)
Applies a demographic enabler query to this bin.
|
void |
applyDemographicEnablerSequencing(DemographicEnablerSearchOrder demographicEnablerSearchOrder)
Applies a demographic enabler 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. |
DemographicEnablerQuery |
getDemographicEnablerQuery()
Gets a demographic enabler query.
|
DemographicEnablerQuery |
getDemographicEnablerQueryFromInspector(DemographicEnablerQueryInspector demographicEnablerQueryInspector)
Gets a demographic enabler query from an inspector.
|
DemographicEnablerSearchOrder |
getDemographicEnablerSearchOrder()
Gets a demographic enabler search order.
|
DemographicEnablerQueryInspector |
inspectDemographicEnablerQuery()
Gets a demographic enabler 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. DemographicEnablerQuery getDemographicEnablerQuery()
mandatory
- This method must be implemented. DemographicEnablerSearchOrder getDemographicEnablerSearchOrder()
mandatory
- This method must be implemented. void applyDemographicEnablerQuery(DemographicEnablerQuery demographicEnablerQuery) throws OperationFailedException, PermissionDeniedException
demographicEnablerQuery
- the demographic enabler queryNullArgumentException
- demographicEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- demographicEnablerQuery
not of this servicemandatory
- This method must be implemented. DemographicEnablerQueryInspector inspectDemographicEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyDemographicEnablerSequencing(DemographicEnablerSearchOrder demographicEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
demographicEnablerSearchOrder
- the demographic enabler search
orderNullArgumentException
-
demographicEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
demographicEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. DemographicEnablerQuery getDemographicEnablerQueryFromInspector(DemographicEnablerQueryInspector demographicEnablerQueryInspector)
demographicEnablerQueryInspector
- a demographic enabler query
inspectorNullArgumentException
-
demographicEnablerQueryInspector
is null
UnsupportedException
-
demographicEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.