public interface OfferingConstrainerSmartCatalogueSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogues. An OfferingConstrainerQuery
can be retrieved
from this session and mapped to this Catalogue
to create a
virtual collection of offering constrainers. The offering constrainer may
be sequenced using the OfferingConstrainerSearchOrder
from
this session.
This Catalogue
has a default query that matches any
offering constrainer and a default search order that specifies no
sequencing. The queries may be examined using an
OfferingConstrainerQueryInspector.
The query may be modified by
converting the inspector back to an OfferingConstrainerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyOfferingConstrainerQuery(OfferingConstrainerQuery offeringConstrainerQuery)
Applies an offering constrainer query to this catalogue.
|
void |
applyOfferingConstrainerSequencing(OfferingConstrainerSearchOrder offeringConstrainerSearchOrder)
Applies an offering constrainer 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. |
OfferingConstrainerQuery |
getOfferingConstrainerQuery()
Gets an offering constrainer query.
|
OfferingConstrainerQuery |
getOfferingConstrainerQueryFromInspector(OfferingConstrainerQueryInspector offeringConstrainerQueryInspector)
Gets an offering constrainer query from an inspector.
|
OfferingConstrainerSearchOrder |
getOfferingConstrainerSearchOrder()
Gets an offering constrainer search order.
|
OfferingConstrainerQueryInspector |
inspectOfferingConstrainerQuery()
Gets an offering constrainer 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. OfferingConstrainerQuery getOfferingConstrainerQuery()
mandatory
- This method must be implemented. OfferingConstrainerSearchOrder getOfferingConstrainerSearchOrder()
mandatory
- This method must be implemented. void applyOfferingConstrainerQuery(OfferingConstrainerQuery offeringConstrainerQuery) throws OperationFailedException, PermissionDeniedException
offeringConstrainerQuery
- the offering constrainer queryNullArgumentException
- offeringConstrainerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- offeringConstrainerQuery
not of this servicemandatory
- This method must be implemented. OfferingConstrainerQueryInspector inspectOfferingConstrainerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyOfferingConstrainerSequencing(OfferingConstrainerSearchOrder offeringConstrainerSearchOrder) throws OperationFailedException, PermissionDeniedException
offeringConstrainerSearchOrder
- the offering constrainer search
orderNullArgumentException
-
offeringConstrainerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
offeringConstrainerSearchOrder
not of this servicemandatory
- This method must be implemented. OfferingConstrainerQuery getOfferingConstrainerQueryFromInspector(OfferingConstrainerQueryInspector offeringConstrainerQueryInspector)
offeringConstrainerQueryInspector
- an offering constrainer
query inspectorNullArgumentException
-
offeringConstrainerQueryInspector
is null
UnsupportedException
-
offeringConstrainerQueryInspector
is not of this
servicemandatory
- This method must be implemented.