public interface CanonicalUnitProcessorSmartCatalogueSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogues. A CanonicalUnitProcessorQuery
can be retrieved
from this session and mapped to this Catalogue
to create a
virtual collection of canonical unit processors. The canonical unit
processor may be sequenced using the
CanonicalUnitProcessorSearchOrder
from this session.
This Catalogue
has a default query that matches any
canonical unit processor and a default search order that specifies no
sequencing. The queries may be examined using a
CanonicalUnitProcessorQueryInspector.
The query may be modified by
converting the inspector back to a CanonicalUnitProcessorQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyCanonicalUnitProcessorQuery(CanonicalUnitProcessorQuery canonicalUnitProcessorQuery)
Applies a canonical unit processor query to this catalogue.
|
void |
applyCanonicalUnitProcessorSequencing(CanonicalUnitProcessorSearchOrder canonicalUnitProcessorSearchOrder)
Applies a canonical unit processor search order to this catalogue.
|
boolean |
canManageSmartCatalogues()
Tests if this user can manage smart catalogues.
|
CanonicalUnitProcessorQuery |
getCanonicalUnitProcessorQuery()
Gets a canonical unit processor query.
|
CanonicalUnitProcessorQuery |
getCanonicalUnitProcessorQueryFromInspector(CanonicalUnitProcessorQueryInspector canonicalUnitProcessorQueryInspector)
Gets a canonical unit processor query from an inspector.
|
CanonicalUnitProcessorSearchOrder |
getCanonicalUnitProcessorSearchOrder()
Gets a canonical unit processor search order.
|
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
CanonicalUnitProcessorQueryInspector |
inspectCanonicalUnitProcessorQuery()
Gets a canonical unit processor query inspector for this catalogue.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCatalogueId()
Catalogue
Id
associated with
this session. Catalogue Id
associated with this sessionmandatory
- This method must be implemented. Catalogue getCatalogue() throws OperationFailedException, PermissionDeniedException
Catalogue
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartCatalogues()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart catalogue management is not
authorized, true
otherwisemandatory
- This method must be implemented. CanonicalUnitProcessorQuery getCanonicalUnitProcessorQuery()
mandatory
- This method must be implemented. CanonicalUnitProcessorSearchOrder getCanonicalUnitProcessorSearchOrder()
mandatory
- This method must be implemented. void applyCanonicalUnitProcessorQuery(CanonicalUnitProcessorQuery canonicalUnitProcessorQuery) throws OperationFailedException, PermissionDeniedException
canonicalUnitProcessorQuery
- the canonical unit processor queryNullArgumentException
-
canonicalUnitProcessorQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
canonicalUnitProcessorQuery
not of this servicemandatory
- This method must be implemented. CanonicalUnitProcessorQueryInspector inspectCanonicalUnitProcessorQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyCanonicalUnitProcessorSequencing(CanonicalUnitProcessorSearchOrder canonicalUnitProcessorSearchOrder) throws OperationFailedException, PermissionDeniedException
canonicalUnitProcessorSearchOrder
- the canonical unit processor
search orderNullArgumentException
-
canonicalUnitProcessorSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
canonicalUnitProcessorSearchOrder
not of this servicemandatory
- This method must be implemented. CanonicalUnitProcessorQuery getCanonicalUnitProcessorQueryFromInspector(CanonicalUnitProcessorQueryInspector canonicalUnitProcessorQueryInspector)
canonicalUnitProcessorQueryInspector
- a canonical unit
processor query inspectorNullArgumentException
-
canonicalUnitProcessorQueryInspector
is null
UnsupportedException
-
canonicalUnitProcessorQueryInspector
is not of this
servicemandatory
- This method must be implemented.