public interface ModelSmartWarehouseSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A ModelQuery
can be retrieved from this session
and mapped to this CoursOfferingeCatalog
to create a
virtual collection of Models.
The models may be sequenced
using the ModelSearchOrder
from this session.
This Warehouse
has a default query that matches any
model and a default search order that specifies no sequencing. The queries
may be examined using a ModelQueryInspector.
The query may
be modified by converting the inspector back to a ModelQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyModelQuery(ModelQuery modelQuery)
Applies a model query to this warehouse.
|
void |
applyModelSequencing(ModelSearchOrder modelSearchOrder)
Applies a model search order to this warehouse.
|
boolean |
canManageSmartWarehouses()
Tests if this user can manage smart warehouses.
|
ModelQuery |
getModelQuery()
Gets a model query.
|
ModelQuery |
getModelQueryFromInspector(ModelQueryInspector modelQueryInspector)
Gets a model query from an inspector.
|
ModelSearchOrder |
getModelSearchOrder()
Gets a model search order.
|
Warehouse |
getWarehouse()
Gets the
Warehouse associated with this session. |
Id |
getWarehouseId()
Gets the
Warehouse Id associated with
this session. |
ModelQueryInspector |
inspectModelQuery()
Gets a model query inspector for this warehouse.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getWarehouseId()
Warehouse
Id
associated with
this session. Warehouse Id
associated with this sessionmandatory
- This method must be implemented. Warehouse getWarehouse() throws OperationFailedException, PermissionDeniedException
Warehouse
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartWarehouses()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart warehouse management is not
authorized, true
otherwisemandatory
- This method must be implemented. ModelQuery getModelQuery()
mandatory
- This method must be implemented. ModelSearchOrder getModelSearchOrder()
mandatory
- This method must be implemented. void applyModelQuery(ModelQuery modelQuery) throws OperationFailedException, PermissionDeniedException
modelQuery
- the model queryNullArgumentException
- modelQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- modelQuery
not of
this servicemandatory
- This method must be implemented. ModelQueryInspector inspectModelQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyModelSequencing(ModelSearchOrder modelSearchOrder) throws OperationFailedException, PermissionDeniedException
modelSearchOrder
- the model search orderNullArgumentException
- modelSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- modelSearchOrder
not of this servicemandatory
- This method must be implemented. ModelQuery getModelQueryFromInspector(ModelQueryInspector modelQueryInspector)
modelQueryInspector
- a query inspectorNullArgumentException
- modelQueryInspector
is null
UnsupportedException
- modelQueryInspector
is not of this servicemandatory
- This method must be implemented.