public interface ParticipantQuerySession extends OsidSession
This session provides methods for querying Participant
objects. The search query is constructed using the
ParticipantQuery.
This session defines views that offer differing behaviors for searching.
Participants may have a query record indicated by their respective
record types. The query record is accessed via the
ParticipantQuery.
The returns in this session may not be cast
directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchParticipants()
Tests if this user can perform
Participant searches. |
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.
|
ParticipantList |
getParticipantsByQuery(ParticipantQuery participantQuery)
Gets a list of participants matching the given participant query.
|
void |
useFederatedCatalogueView()
Federates the view for methods in this session.
|
void |
useIsolatedCatalogueView()
Isolates the view for methods in this session.
|
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 canSearchParticipants()
Participant
searches. A
return of true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this session will
result in a PERMISSION_DENIED.
This is intended as a
hint to an application that may wish not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedCatalogueView()
mandatory
- This method is must be implemented. void useIsolatedCatalogueView()
mandatory
- This method is must be implemented. ParticipantQuery getParticipantQuery()
mandatory
- This method must be implemented. ParticipantList getParticipantsByQuery(ParticipantQuery participantQuery) throws OperationFailedException, PermissionDeniedException
participantQuery
- the participant query ParticipantList
NullArgumentException
- participantQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- participantQuery
is not of this servicemandatory
- This method must be implemented.