public interface CatalogEnablerSmartCatalogSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A CatalogEnablerQuery
can be retrieved from this
session and mapped to this Catalog
to create a virtual
collection of catalog enablers. The catalog enablers may be sequenced
using the CatalogEnablerSearchOrder
from this session.
This Catalog
has a default query that matches any
catalog enabler and a default search order that specifies no sequencing.
The queries may be examined using a CatalogEnablerQueryInspector.
The query may be modified by converting the inspector back to a
CatalogEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyCatalogEnablerQuery(CatalogEnablerQuery catalogEnablerQuery)
Applies a catalog enabler query to this catalog.
|
void |
applyCatalogEnablerSequencing(CatalogEnablerSearchOrder catalogEnablerSearchOrder)
Applies a catalog enabler search order to this catalog.
|
boolean |
canManageSmartCatalogs()
Tests if this user can manage smart catalogs.
|
Catalog |
getCatalog()
Gets the
Catalog associated with this session. |
CatalogEnablerQuery |
getCatalogEnablerQuery()
Gets a catalog enabler query.
|
CatalogEnablerQuery |
getCatalogEnablerQueryFromInspector(CatalogEnablerQueryInspector catalogEnablerQueryInspector)
Gets a catalog enabler query from an inspector.
|
CatalogEnablerSearchOrder |
getCatalogEnablerSearchOrder()
Gets a catalog enabler search order.
|
Id |
getCatalogId()
Gets the
Catalog Id associated with this
session. |
CatalogEnablerQueryInspector |
inspectCatalogEnablerQuery()
Gets a catalog enabler query inspector for this catalog.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCatalogId()
Catalog
Id
associated with this
session. Catalog Id
associated with this sessionmandatory
- This method must be implemented. Catalog getCatalog() throws OperationFailedException, PermissionDeniedException
Catalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartCatalogs()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart catalog management is not
authorized, true
otherwisemandatory
- This method must be implemented. CatalogEnablerQuery getCatalogEnablerQuery()
mandatory
- This method must be implemented. CatalogEnablerSearchOrder getCatalogEnablerSearchOrder()
mandatory
- This method must be implemented. void applyCatalogEnablerQuery(CatalogEnablerQuery catalogEnablerQuery) throws OperationFailedException, PermissionDeniedException
catalogEnablerQuery
- the catalog enabler queryNullArgumentException
- catalogEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- catalogEnablerQuery
not of this servicemandatory
- This method must be implemented. CatalogEnablerQueryInspector inspectCatalogEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyCatalogEnablerSequencing(CatalogEnablerSearchOrder catalogEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
catalogEnablerSearchOrder
- the catalog enabler search orderNullArgumentException
-
catalogEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- catalogEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. CatalogEnablerQuery getCatalogEnablerQueryFromInspector(CatalogEnablerQueryInspector catalogEnablerQueryInspector)
catalogEnablerQueryInspector
- a catalog enabler query inspectorNullArgumentException
-
catalogEnablerQueryInspector
is null
UnsupportedException
-
catalogEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.