Interface | osid.voting.CandidateSmartPollsSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
Method | getPollsId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Polls Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getPolls | ||
Description |
Gets the | ||
Return | osid.voting.Polls | the Polls associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartPolls | ||
Description |
Tests if this user can manage smart polls. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known methods in this
session will result in a | ||
Return | boolean | false if smart polls management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCandidateQuery | ||
Description |
Gets a candidate query. | ||
Return | osid.voting.CandidateQuery | the candidate query | |
Compliance | mandatory | This method must be implemented. | |
Method | getCandidateSearchOrder | ||
Description |
Gets a candidate search order. | ||
Return | osid.voting.CandidateSearchOrder | the candidate search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyCandidateQuery | ||
Description |
Applies a candidate query to this polls. | ||
Parameters | osid.voting.CandidateQuery | candidateQuery | the candidate query |
Errors | NULL_ARGUMENT | candidateQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | candidateQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectCandidateQuery | ||
Description |
Gets a candidate query inspector for this polls. | ||
Return | osid.voting.CandidateQueryInspector | the candidate query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyCandidateSequencing | ||
Description |
Applies a candidate search order to this polls. | ||
Parameters | osid.voting.CandidateSearchOrder | candidateSearchOrder | the candidate search order |
Errors | NULL_ARGUMENT | candidateSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | candidateSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCandidateQueryFromInspector | ||
Description |
Gets a candidate query from an inspector. | ||
Parameters | osid.voting.CandidateQueryInspector | candidateQueryInspector | a candidate query inspector |
Return | osid.voting.CandidateQuery | the candidate query | |
Errors | NULL_ARGUMENT | candidateQueryInspector is null | |
UNSUPPORTED | candidateQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |