public interface CredentialEntrySmartCourseCatalogSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A CredentialEntryQuery
can be retrieved from this
session and mapped to this CourseCatalog
to create a
virtual collection of CredentialEntries.
The courses may be
sequenced using the CredentialEntrySearchOrder
from this
session.
This CourseCatalog
has a default query that matches any
course and a default search order that specifies no sequencing. The
queries may be examined using a CredentialEntryQueryInspector.
The query may be modified by converting the inspector back to a
CredentialEntryQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyCredentialEntryQuery(CredentialEntryQuery credentialEntryQuery)
Applies a credential entry query to this course catalog.
|
void |
applyCredentialEntrySequencing(CredentialEntrySearchOrder credentialEntrySearchOrder)
Applies a credential entry search order to this course catalog.
|
boolean |
canManageSmartCourseCatalogs()
Tests if this user can manage smart course catalogs.
|
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
CredentialEntryQuery |
getCredentialEntryQuery()
Gets a credential entry query.
|
CredentialEntryQuery |
getCredentialEntryQueryFromInspector(CredentialEntryQueryInspector credentialEntryQueryInspector)
Gets a credential entry query from an inspector.
|
CredentialEntrySearchOrder |
getCredentialEntrySearchOrder()
Gets a credential entry search order.
|
CredentialEntryQueryInspector |
inspectCredentialEntryQuery()
Gets a credential entry query inspector for this course catalog.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCourseCatalogId()
CourseCatalog
Id
associated
with this session. CourseCatalog Id
associated with this
sessionmandatory
- This method must be implemented. CourseCatalog getCourseCatalog() throws OperationFailedException, PermissionDeniedException
CourseCatalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartCourseCatalogs()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart course catalog management is not
authorized, true
otherwisemandatory
- This method must be implemented. CredentialEntryQuery getCredentialEntryQuery()
mandatory
- This method must be implemented. CredentialEntrySearchOrder getCredentialEntrySearchOrder()
mandatory
- This method must be implemented. void applyCredentialEntryQuery(CredentialEntryQuery credentialEntryQuery) throws OperationFailedException, PermissionDeniedException
credentialEntryQuery
- the credential entry queryNullArgumentException
- credentialEntryQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- credentialEntryQuery
not of this servicemandatory
- This method must be implemented. CredentialEntryQueryInspector inspectCredentialEntryQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyCredentialEntrySequencing(CredentialEntrySearchOrder credentialEntrySearchOrder) throws OperationFailedException, PermissionDeniedException
credentialEntrySearchOrder
- the credential entry search orderNullArgumentException
-
credentialEntrySearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
credentialEntrySearchOrder
not of this servicemandatory
- This method must be implemented. CredentialEntryQuery getCredentialEntryQueryFromInspector(CredentialEntryQueryInspector credentialEntryQueryInspector)
credentialEntryQueryInspector
- a query inspectorNullArgumentException
-
credentialEntryQueryInspector
is null
UnsupportedException
-
credentialEntryQueryInspector
is not of this servicemandatory
- This method must be implemented.