public interface OfferingConstrainerEnablerSmartCatalogueSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogues. An OfferingConstrainerEnablerQuery
can be
retrieved from this session and mapped to this Catalogue
to
create a virtual collection of offering constrainer enablers. The offering
constrainer enablers may be sequenced using the
OfferingConstrainerEnablerSearchOrder
from this session.
This Catalogue
has a default query that matches any
offering constrainer enabler and a default search order that specifies no
sequencing. The queries may be examined using an
OfferingConstrainerEnablerQueryInspector.
The query may be
modified by converting the inspector back to an
OfferingConstrainerEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyOfferingConstrainerEnablerQuery(OfferingConstrainerEnablerQuery offeringConstrainerEnablerQuery)
Applies an offering constrainer enabler query to this catalogue.
|
void |
applyOfferingConstrainerEnablerSequencing(OfferingConstrainerEnablerSearchOrder offeringConstrainerEnablerSearchOrder)
Applies an offering constrainer enabler 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. |
OfferingConstrainerEnablerQuery |
getOfferingConstrainerEnablerQuery()
Gets an offering constrainer enabler query.
|
OfferingConstrainerEnablerQuery |
getOfferingConstrainerEnablerQueryFromInspector(OfferingConstrainerEnablerQueryInspector offeringConstrainerEnablerQueryInspector)
Gets an offering constrainer enabler query from an inspector.
|
OfferingConstrainerEnablerSearchOrder |
getOfferingConstrainerEnablerSearchOrder()
Gets an offering constrainer enabler search order.
|
OfferingConstrainerEnablerQueryInspector |
inspectOfferingConstrainerEnablerQuery()
Gets an offering constrainer 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. OfferingConstrainerEnablerQuery getOfferingConstrainerEnablerQuery()
mandatory
- This method must be implemented. OfferingConstrainerEnablerSearchOrder getOfferingConstrainerEnablerSearchOrder()
mandatory
- This method must be implemented. void applyOfferingConstrainerEnablerQuery(OfferingConstrainerEnablerQuery offeringConstrainerEnablerQuery) throws OperationFailedException, PermissionDeniedException
offeringConstrainerEnablerQuery
- the offering constrainer
enabler queryNullArgumentException
-
offeringConstrainerEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
offeringConstrainerEnablerQuery
not of this servicemandatory
- This method must be implemented. OfferingConstrainerEnablerQueryInspector inspectOfferingConstrainerEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyOfferingConstrainerEnablerSequencing(OfferingConstrainerEnablerSearchOrder offeringConstrainerEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
offeringConstrainerEnablerSearchOrder
- the offering constrainer
enabler search orderNullArgumentException
-
offeringConstrainerEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
offeringConstrainerEnablerSearchOrder
not of this
servicemandatory
- This method must be implemented. OfferingConstrainerEnablerQuery getOfferingConstrainerEnablerQueryFromInspector(OfferingConstrainerEnablerQueryInspector offeringConstrainerEnablerQueryInspector)
offeringConstrainerEnablerQueryInspector
- an offering
constrainer enabler query inspectorNullArgumentException
-
offeringConstrainerEnablerQueryInspector
is
null
UnsupportedException
-
offeringConstrainerEnablerQueryInspector
is not of
this servicemandatory
- This method must be implemented.