public interface CandidateSmartPollsSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A CandidateQuery
can be retrieved from this
session and mapped to this Polls
to create a virtual
collection of Candidates.
The candidates may be sequenced
using the CandidateSearchOrder
from this session.
This Polls
has a default query that matches any
candidate and a default search order that specifies no sequencing. The
queries may be examined using a CandidateQueryInspector.
The query may be modified by converting the inspector back to a
CandidateQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyCandidateQuery(CandidateQuery candidateQuery)
Applies a candidate query to this polls.
|
void |
applyCandidateSequencing(CandidateSearchOrder candidateSearchOrder)
Applies a candidate search order to this polls.
|
boolean |
canManageSmartPolls()
Tests if this user can manage smart polls.
|
CandidateQuery |
getCandidateQuery()
Gets a candidate query.
|
CandidateQuery |
getCandidateQueryFromInspector(CandidateQueryInspector candidateQueryInspector)
Gets a candidate query from an inspector.
|
CandidateSearchOrder |
getCandidateSearchOrder()
Gets a candidate search order.
|
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
CandidateQueryInspector |
inspectCandidateQuery()
Gets a candidate query inspector for this polls.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getPollsId()
Polls
Id
associated with this
session. Polls Id
associated with this sessionmandatory
- This method must be implemented. Polls getPolls() throws OperationFailedException, PermissionDeniedException
Polls
associated with this session. Polls
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartPolls()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart polls management is not
authorized, true
otherwisemandatory
- This method must be implemented. CandidateQuery getCandidateQuery()
mandatory
- This method must be implemented. CandidateSearchOrder getCandidateSearchOrder()
mandatory
- This method must be implemented. void applyCandidateQuery(CandidateQuery candidateQuery) throws OperationFailedException, PermissionDeniedException
candidateQuery
- the candidate queryNullArgumentException
- candidateQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- candidateQuery
not of this servicemandatory
- This method must be implemented. CandidateQueryInspector inspectCandidateQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyCandidateSequencing(CandidateSearchOrder candidateSearchOrder) throws OperationFailedException, PermissionDeniedException
candidateSearchOrder
- the candidate search orderNullArgumentException
- candidateSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- candidateSearchOrder
not of this servicemandatory
- This method must be implemented. CandidateQuery getCandidateQueryFromInspector(CandidateQueryInspector candidateQueryInspector)
candidateQueryInspector
- a candidate query inspectorNullArgumentException
- candidateQueryInspector
is null
UnsupportedException
- candidateQueryInspector
is not of this servicemandatory
- This method must be implemented.