Interface | osid.voting.BallotSmartPollsSession | ||
---|---|---|---|
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 | getBallotQuery | ||
Description |
Gets a ballot query. | ||
Return | osid.voting.BallotQuery | the ballot query | |
Compliance | mandatory | This method must be implemented. | |
Method | getBallotSearchOrder | ||
Description |
Gets a ballot search order. | ||
Return | osid.voting.BallotSearchOrder | the ballot search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyBallotQuery | ||
Description |
Applies a ballot query to this polls. | ||
Parameters | osid.voting.BallotQuery | ballotQuery | the ballot query |
Errors | NULL_ARGUMENT | ballotQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | ballotQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectBallotQuery | ||
Description |
Gets a ballot query inspector for this polls. | ||
Return | osid.voting.BallotQueryInspector | the ballot query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyBallotSequencing | ||
Description |
Applies a ballot search order to this polls. | ||
Parameters | osid.voting.BallotSearchOrder | ballotSearchOrder | the ballot search order |
Errors | NULL_ARGUMENT | ballotSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | ballotSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBallotQueryFromInspector | ||
Description |
Gets a ballot query from an inspector. | ||
Parameters | osid.voting.BallotQueryInspector | ballotQueryInspector | a ballot query inspector |
Return | osid.voting.BallotQuery | the ballot query | |
Errors | NULL_ARGUMENT | ballotQueryInspector is null | |
UNSUPPORTED | ballotQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |