public interface ItemSmartBankSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An ItemQuery
can be retrieved from this session
and mapped to this Bank
to create a virtual collection of
Items.
The Items may be sequenced using the
ItemSearchOrder
from this session.
This Bank
has a default query that matches any Item and
a default search order that specifies no sequencing. The queries may be
examined using an ItemQueryInspector.
The query may be
modified by converting the inspector back to an ItemQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyItemQuery(ItemQuery itemQuery)
Applies an item query to this bank.
|
void |
applyItemSequencing(ItemSearchOrder itemSearchOrder)
Applies an item search order to this bank.
|
boolean |
canManageSmartBanks()
Tests if this user can manage smart banks.
|
Bank |
getBank()
Gets the
Bank associated with this session. |
Id |
getBankId()
Gets the
Bank Id associated with this
session. |
ItemQuery |
getItemQuery()
Gets an assessment item query.
|
ItemQuery |
getItemQueryFromInspector(ItemQueryInspector itemQueryInspector)
Gets an item query from an inspector.
|
ItemSearchOrder |
getItemSearchOrder()
Gets an assessment item search order.
|
ItemQueryInspector |
inspectItemQuery()
Gets an item query inspector for this bank.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBankId()
Bank
Id
associated with this
session. Bank Id
associated with this sessionmandatory
- This method must be implemented. Bank getBank() throws OperationFailedException, PermissionDeniedException
Bank
associated with this session. Bank
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartBanks()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart bank management is not
authorized, true
otherwisemandatory
- This method must be implemented. ItemQuery getItemQuery()
mandatory
- This method must be implemented. ItemSearchOrder getItemSearchOrder()
mandatory
- This method must be implemented. void applyItemQuery(ItemQuery itemQuery) throws OperationFailedException, PermissionDeniedException
itemQuery
- the item queryNullArgumentException
- itemQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- itemQuery
not of
this servicemandatory
- This method must be implemented. ItemQueryInspector inspectItemQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyItemSequencing(ItemSearchOrder itemSearchOrder) throws OperationFailedException, PermissionDeniedException
itemSearchOrder
- the item search orderNullArgumentException
- itemSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- itemSearchOrder
not of this servicemandatory
- This method must be implemented. ItemQuery getItemQueryFromInspector(ItemQueryInspector itemQueryInspector)
itemQueryInspector
- an item query inspectorNullArgumentException
- itemQueryInspector
is null
UnsupportedException
- itemQueryInspector
is not of this servicemandatory
- This method must be implemented.