public interface CanonicalUnitSmartCatalogueSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A CanonicalUnitQuery
can be retrieved from this
session and mapped to this Catalogue
to create a virtual
collection of CanonicalUnits.
The canonical units may be
sequenced using the CanonicalUnitSearchOrder
from this
session.
This Catalogue
has a default query that matches any
canonical unit and a default search order that specifies no sequencing.
The queries may be examined using a CanonicalUnitQueryInspector.
The query may be modified by converting the inspector back to a
CanonicalUnitQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyCanonicalUnitQuery(CanonicalUnitQuery canonicalUnitQuery)
Applies a canonical unit query to this catalogue.
|
void |
applyCanonicalUnitSequencing(CanonicalUnitSearchOrder canonicalUnitSearchOrder)
Applies a canonical unit search order to this catalogue.
|
boolean |
canManageSmartCatalogues()
Tests if this user can manage smart catalogues.
|
CanonicalUnitQuery |
getCanonicalUnitQuery()
Gets a canonical unit query.
|
CanonicalUnitQuery |
getCanonicalUnitQueryFromInspector(CanonicalUnitQueryInspector canonicalUnitQueryInspector)
Gets a canonical unit query from an inspector.
|
CanonicalUnitSearchOrder |
getCanonicalUnitSearchOrder()
Gets a canonical unit search order.
|
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
CanonicalUnitQueryInspector |
inspectCanonicalUnitQuery()
Gets a canonical unit 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. Catalogue
associated with this sessionOperationFailedException
- 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. CanonicalUnitQuery getCanonicalUnitQuery()
mandatory
- This method must be implemented. CanonicalUnitSearchOrder getCanonicalUnitSearchOrder()
mandatory
- This method must be implemented. void applyCanonicalUnitQuery(CanonicalUnitQuery canonicalUnitQuery) throws OperationFailedException, PermissionDeniedException
canonicalUnitQuery
- the canonical unit queryNullArgumentException
- canonicalUnitQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- canonical unitQuery
not of this servicemandatory
- This method must be implemented. CanonicalUnitQueryInspector inspectCanonicalUnitQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyCanonicalUnitSequencing(CanonicalUnitSearchOrder canonicalUnitSearchOrder) throws OperationFailedException, PermissionDeniedException
canonicalUnitSearchOrder
- the canonical unit search orderNullArgumentException
- canonicalUnitSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- canonicalUnitSearchOrder
not of this servicemandatory
- This method must be implemented. CanonicalUnitQuery getCanonicalUnitQueryFromInspector(CanonicalUnitQueryInspector canonicalUnitQueryInspector)
canonicalUnitQueryInspector
- a query inspectorNullArgumentException
-
canonicalUnitQueryInspector
is null
UnsupportedException
-
canonicalUnitQueryInspector
is not of this servicemandatory
- This method must be implemented.