public interface ParticipantSmartCatalogueSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A ParticipantQuery
can be retrieved from this
session and mapped to this Catalogue
to create a virtual
collection of Participants.
The participants may be
sequenced using the ParticipantSearchOrder
from this
session.
This Catalogue
has a default query that matches any
participant and a default search order that specifies no sequencing. The
queries may be examined using a ParticipantQueryInspector.
The query may be modified by converting the inspector back to a
ParticipantQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyParticipantQuery(ParticipantQuery participantQuery)
Applies a participant query to this catalogue.
|
void |
applyParticipantSequencing(ParticipantSearchOrder participantSearchOrder)
Applies a participant 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. |
ParticipantQuery |
getParticipantQuery()
Gets a participant query.
|
ParticipantQuery |
getParticipantQueryFromInspector(ParticipantQueryInspector participantQueryInspector)
Gets a participant query from an inspector.
|
ParticipantSearchOrder |
getParticipantSearchOrder()
Gets a participant search order.
|
ParticipantQueryInspector |
inspectParticipantQuery()
Gets a participant 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. ParticipantQuery getParticipantQuery()
mandatory
- This method must be implemented. ParticipantSearchOrder getParticipantSearchOrder()
mandatory
- This method must be implemented. void applyParticipantQuery(ParticipantQuery participantQuery) throws OperationFailedException, PermissionDeniedException
participantQuery
- the participant queryNullArgumentException
- participantQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- participantQuery
not of this servicemandatory
- This method must be implemented. ParticipantQueryInspector inspectParticipantQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyParticipantSequencing(ParticipantSearchOrder participantSearchOrder) throws OperationFailedException, PermissionDeniedException
participantSearchOrder
- the participant search orderNullArgumentException
- participantSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- participantSearchOrder
not of this servicemandatory
- This method must be implemented. ParticipantQuery getParticipantQueryFromInspector(ParticipantQueryInspector participantQueryInspector)
participantQueryInspector
- a query inspectorNullArgumentException
-
participantQueryInspector
is null
UnsupportedException
- participantQueryInspector
is not of this servicemandatory
- This method must be implemented.