OSID Specifications
voting package
Version 3.0.0
Release Candidate Preview
voting package
Version 3.0.0
Release Candidate Preview
| Interface | osid.voting.VoteForm | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipForm | ||
| Description |
This is the form for creating and updating | ||
| Method | getVotesMetadata | ||
| Description |
Gets the metadata for the number of votes. | ||
| Return | osid.Metadata | metadata for the votes | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setVotes | ||
| Description |
Sets the votes. | ||
| Parameters | integer | votes | the votes |
| Errors | INVALID_ARGUMENT | votes is invalid | |
| NO_ACCESS | Metadata.isReadOnly() is true | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearVotes | ||
| Description |
Clears the votes. | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getVoteFormRecord | ||
| Description |
Gets the | ||
| Parameters | osid.type.Type | voteRecordType | the vote record type |
| Return | osid.voting.records.VoteFormRecord | the vote form record | |
| Errors | NULL_ARGUMENT | voteRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(voteRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |