public interface DemographicBuilderSession extends OsidSession
This session applies resource search queries and search orders to
Demographics.
Applying a search query to a demographic adds
the resources resulting from that query to the demographic.
Modifier and Type | Method and Description |
---|---|
void |
applyResourceQuery(Id demographicId,
ResourceQuery resourceQuery)
Applies a resource query to a demographic.
|
void |
applyResourceSequencing(Id demographicId,
ResourceSearchOrder resourceSearchOrder)
Applies a demographic search order to this bin.
|
boolean |
canBuildDemographics()
Tests if this user can build demographics.
|
void |
clearResourceQuery(Id demographicId)
Clears the resource query effectively replacing it with a wildcard
query.
|
void |
clearResourceSequencing(Id demographicId)
Clears the resource sequencing.
|
Bin |
getBin()
Gets the
Bin associated with this session. |
Id |
getBinId()
Gets the
Bin Id associated with this
session. |
ResourceQuery |
getResourceQuery()
Gets a resource query.
|
ResourceQuery |
getResourceQueryFromInspector(ResourceQueryInspector resourceQueryInspector)
Gets a resource query from an inspector.
|
ResourceSearchOrder |
getResourceSearchOrder()
Gets a resource search order.
|
ResourceQueryInspector |
inspectResourceQuery(Id demographicId)
Gets a resource query inspector for a demographic.
|
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 canBuildDemographics()
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. ResourceQuery getResourceQuery()
mandatory
- This method must be implemented. ResourceSearchOrder getResourceSearchOrder()
mandatory
- This method must be implemented. void applyResourceQuery(Id demographicId, ResourceQuery resourceQuery) throws NotFoundException, OperationFailedException, PermissionDeniedException
demographicId
- a demographic Id
resourceQuery
- the resource queryNotFoundException
- demographicId
is not
foundNullArgumentException
- demographicId
or
resourceQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- resourceQuery
did
not originate from getResourceQuery()
mandatory
- This method must be implemented. ResourceQueryInspector inspectResourceQuery(Id demographicId) throws NotFoundException, OperationFailedException, PermissionDeniedException
demographicId
- a demographic Id
NotFoundException
- demographicId
is not
foundNullArgumentException
- demographicId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void clearResourceQuery(Id demographicId) throws NotFoundException, OperationFailedException, PermissionDeniedException
demographicId
- a demographic Id
NotFoundException
- demographicId
is not
foundNullArgumentException
- demographicId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyResourceSequencing(Id demographicId, ResourceSearchOrder resourceSearchOrder) throws NotFoundException, OperationFailedException, PermissionDeniedException
demographicId
- a demographic Id
resourceSearchOrder
- the resource search orderNotFoundException
- demographicId
is not
foundNullArgumentException
- demographicId
or
resourceSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- resourceSearchOrder
did not originate from getResourceSearchOrder()
mandatory
- This method must be implemented. void clearResourceSequencing(Id demographicId) throws NotFoundException, OperationFailedException, PermissionDeniedException
demographicId
- a demographic Id
NotFoundException
- demographicId
is not
foundNullArgumentException
- demographicId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. ResourceQuery getResourceQueryFromInspector(ResourceQueryInspector resourceQueryInspector)
resourceQueryInspector
- a resource query inspectorNullArgumentException
- resourceQueryInspector
is null
UnsupportedException
- resourceQueryInspector
is not of this servicemandatory
- This method must be implemented.