public interface CommissionSmartFoundrySession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A CommissionQuery
can be retrieved from this
session and foundryped to this Foundry
to create a virtual
collection of Commissions.
The commissions may be sequenced
using the CommissionSearchOrder
from this session.
This Foundry
has a default query that matches any
commission and a default search order that specifies no sequencing. The
queries may be examined using a CommissionQueryInspector.
The query may be modified by converting the inspector back to a
CommissionQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyCommissionQuery(CommissionQuery commissionQuery)
Applies a commission query to this foundry.
|
void |
applyCommissionSequencing(CommissionSearchOrder commissionSearchOrder)
Applies a commission search order to this foundry.
|
boolean |
canManageSmartFoundries()
Tests if this user can manage smart foundries.
|
CommissionQuery |
getCommissionQuery()
Gets a commission query.
|
CommissionQuery |
getCommissionQueryFromInspector(CommissionQueryInspector commissionQueryInspector)
Gets a commission query from an inspector.
|
CommissionSearchOrder |
getCommissionSearchOrder()
Gets a commission search order.
|
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
CommissionQueryInspector |
inspectCommissionQuery()
Gets a commission query inspector for this foundry.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFoundryId()
Foundry
Id
associated with this
session. Foundry Id
associated with this sessionmandatory
- This method must be implemented. Foundry getFoundry() throws OperationFailedException, PermissionDeniedException
Foundry
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartFoundries()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart foundry management is not
authorized, true
otherwisemandatory
- This method must be implemented. CommissionQuery getCommissionQuery()
mandatory
- This method must be implemented. CommissionSearchOrder getCommissionSearchOrder()
mandatory
- This method must be implemented. void applyCommissionQuery(CommissionQuery commissionQuery) throws OperationFailedException, PermissionDeniedException
commissionQuery
- the commission queryNullArgumentException
- commissionQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- commissionQuery
not of this servicemandatory
- This method must be implemented. CommissionQueryInspector inspectCommissionQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyCommissionSequencing(CommissionSearchOrder commissionSearchOrder) throws OperationFailedException, PermissionDeniedException
commissionSearchOrder
- the commission search orderNullArgumentException
- commissionSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- commissionSearchOrder
not of this servicemandatory
- This method must be implemented. CommissionQuery getCommissionQueryFromInspector(CommissionQueryInspector commissionQueryInspector)
commissionQueryInspector
- a commission query inspectorNullArgumentException
- commissionQueryInspector
is null
UnsupportedException
- commissionQueryInspector
is not of this servicemandatory
- This method must be implemented.