public interface CanonicalUnitEnablerSmartCatalogueSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogues. A CanonicalUnitEnablerQuery
can be retrieved
from this session and mapped to this Catalogue
to create a
virtual collection of canonical unit enablers. The canonical unit enablers
may be sequenced using the CanonicalUnitEnablerSearchOrder
from this session.
This Catalogue
has a default query that matches any
canonical unit enabler and a default search order that specifies no
sequencing. The queries may be examined using a
CanonicalUnitEnablerQueryInspector.
The query may be modified by
converting the inspector back to a CanonicalUnitEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyCanonicalUnitEnablerQuery(CanonicalUnitEnablerQuery canonicalUnitEnablerQuery)
Applies a canonical unit enabler query to this catalogue.
|
void |
applyCanonicalUnitEnablerSequencing(CanonicalUnitEnablerSearchOrder canonicalUnitEnablerSearchOrder)
Applies a canonical unit enabler search order to this catalogue.
|
boolean |
canManageSmartCatalogues()
Tests if this user can manage smart catalogues.
|
CanonicalUnitEnablerQuery |
getCanonicalUnitEnablerQuery()
Gets a canonical unit enabler query.
|
CanonicalUnitEnablerQuery |
getCanonicalUnitEnablerQueryFromInspector(CanonicalUnitEnablerQueryInspector canonicalUnitEnablerQueryInspector)
Gets a canonical unit enabler query from an inspector.
|
CanonicalUnitEnablerSearchOrder |
getCanonicalUnitEnablerSearchOrder()
Gets a canonical unit enabler search order.
|
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
CanonicalUnitEnablerQueryInspector |
inspectCanonicalUnitEnablerQuery()
Gets a canonical unit enabler 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. CanonicalUnitEnablerQuery getCanonicalUnitEnablerQuery()
mandatory
- This method must be implemented. CanonicalUnitEnablerSearchOrder getCanonicalUnitEnablerSearchOrder()
mandatory
- This method must be implemented. void applyCanonicalUnitEnablerQuery(CanonicalUnitEnablerQuery canonicalUnitEnablerQuery) throws OperationFailedException, PermissionDeniedException
canonicalUnitEnablerQuery
- the canonical unit enabler queryNullArgumentException
-
canonicalUnitEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- canonicalUnitEnablerQuery
not of this servicemandatory
- This method must be implemented. CanonicalUnitEnablerQueryInspector inspectCanonicalUnitEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyCanonicalUnitEnablerSequencing(CanonicalUnitEnablerSearchOrder canonicalUnitEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
canonicalUnitEnablerSearchOrder
- the canonical unit enabler
search orderNullArgumentException
-
canonicalUnitEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
canonicalUnitEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. CanonicalUnitEnablerQuery getCanonicalUnitEnablerQueryFromInspector(CanonicalUnitEnablerQueryInspector canonicalUnitEnablerQueryInspector)
canonicalUnitEnablerQueryInspector
- a canonical unit enabler
query inspectorNullArgumentException
-
canonicalUnitEnablerQueryInspector
is null
UnsupportedException
-
canonicalUnitEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.