public interface OfferingSmartCatalogueSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An OfferingQuery
can be retrieved from this
session and mapped to this Catalogue
to create a virtual
collection of Offerings.
The offerings may be sequenced
using the OfferingSearchOrder
from this session.
This Catalogue
has a default query that matches any
offering and a default search order that specifies no sequencing. The
queries may be examined using an OfferingQueryInspector.
The query may be modified by converting the inspector back to a n
OfferingQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyOfferingQuery(OfferingQuery offeringQuery)
Applies an offering query to this catalogue.
|
void |
applyOfferingSequencing(OfferingSearchOrder offeringSearchOrder)
Applies an offering search order to this catalogue.
|
boolean |
canManageSmartCatalogues()
Tests if this user can manage smart catalogues.
|
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
OfferingQuery |
getOfferingQuery()
Gets an offering query.
|
OfferingQuery |
getOfferingQueryFromInspector(OfferingQueryInspector offeringQueryInspector)
Gets an offering query from an inspector.
|
OfferingSearchOrder |
getOfferingSearchOrder()
Gets an offering search order.
|
OfferingQueryInspector |
inspectOfferingQuery()
Gets an offering 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. OfferingQuery getOfferingQuery()
mandatory
- This method must be implemented. OfferingSearchOrder getOfferingSearchOrder()
mandatory
- This method must be implemented. void applyOfferingQuery(OfferingQuery offeringQuery) throws OperationFailedException, PermissionDeniedException
offeringQuery
- the offering queryNullArgumentException
- offeringQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- offeringQuery
not
of this servicemandatory
- This method must be implemented. OfferingQueryInspector inspectOfferingQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyOfferingSequencing(OfferingSearchOrder offeringSearchOrder) throws OperationFailedException, PermissionDeniedException
offeringSearchOrder
- the offering search orderNullArgumentException
- offeringSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- offeringSearchOrder
not of this servicemandatory
- This method must be implemented. OfferingQuery getOfferingQueryFromInspector(OfferingQueryInspector offeringQueryInspector)
offeringQueryInspector
- a query inspectorNullArgumentException
- offeringQueryInspector
is null
UnsupportedException
- offeringQueryInspector
is not of this servicemandatory
- This method must be implemented.