OSID - osid.voting.VotingProfile Service Interface Definition

Interface	osid.voting.VotingProfile
Implements	`osid.OsidProfile`
Implemented By	`osid.voting.VotingManager`
Implemented By	`osid.voting.VotingProxyManager`
Description	The voting profile describes interoperability among voting services.
Method	supportsVisibleFederation
Description	Tests if federation is visible.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsVoting
Description	Tests if voting is supported.
Return	`boolean`		`true` if voting is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRaceResults
Description	Tests if race results is supported.
Return	`boolean`		`true` if race results is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsVotingAllocationLookup
Description	Tests if voting allocation lookup is supported.
Return	`boolean`		`true` if voting allocation lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsVotingAllocationAdmin
Description	Tests if voting allocation administration is supported.
Return	`boolean`		`true` if voting allocation administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsVoteLookup
Description	Tests if looking up votes is supported.
Return	`boolean`		`true` if votes lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsVoteQuery
Description	Tests if querying votes is supported.
Return	`boolean`		`true` if votes query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsVoteSearch
Description	Tests if searching votes is supported.
Return	`boolean`		`true` if votes search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsVoteNotification
Description	Tests if a votes notification service is supported.
Return	`boolean`		`true` if votes notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsVotePolls
Description	Tests if retrieving mappings of votes and polls is supported.
Return	`boolean`		`true` if vote polls mapping retrieval is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsVotePollsAssignment
Description	Tests if managing mappings of votes and polls is supported.
Return	`boolean`		`true` if vote polls assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsVoteSmartPolls
Description	Tests if vote smart polls are available.
Return	`boolean`		`true` if vote smart polls are supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCandidateLookup
Description	Tests if candidate lookup is supported.
Return	`boolean`		`true` if candidate lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCandidateQuery
Description	Tests if candidate query is supported.
Return	`boolean`		`true` if candidate query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCandidateSearch
Description	Tests if candidate search is supported.
Return	`boolean`		`true` if candidate search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCandidateAdmin
Description	Tests if candidate administration is supported.
Return	`boolean`		`true` if candidate administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCandidateNotification
Description	Tests if candidate notification is supported. Messages may be sent when candidates are created, modified, or deleted.
Return	`boolean`		`true` if candidate notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCandidatePolls
Description	Tests if retrieving mappings of candidate and polls is supported.
Return	`boolean`		`true` if candidate polls mapping retrieval is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCandidatePollsAssignment
Description	Tests if managing mappings of candidate and polls is supported.
Return	`boolean`		`true` if candidate polls assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCandidateSmartPolls
Description	Tests if candidate smart polls are available.
Return	`boolean`		`true` if candidate smart polls are supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRaceLookup
Description	Tests if looking up races is supported.
Return	`boolean`		`true` if race lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRaceQuery
Description	Tests if querying races is supported.
Return	`boolean`		`true` if race query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRaceSearch
Description	Tests if searching races is supported.
Return	`boolean`		`true` if races search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRaceAdmin
Description	Tests if a race `a` dministrative service is supported.
Return	`boolean`		`true` if race administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRaceNotification
Description	Tests if a race notification service is supported.
Return	`boolean`		`true` if race notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRacePolls
Description	Tests if retrieving mappings of races and polls is supported.
Return	`boolean`		`true` if race polls mapping retrieval is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRacePollsAssignment
Description	Tests if managing mappings of races and polls is supported.
Return	`boolean`		`true` if race polls assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRaceSmartPolls
Description	Tests if race smart polls are available.
Return	`boolean`		`true` if race smart polls are supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBallotLookup
Description	Tests if looking up ballots is supported.
Return	`boolean`		`true` if ballot lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBallotQuery
Description	Tests if querying ballots is supported.
Return	`boolean`		`true` if ballot query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBallotSearch
Description	Tests if searching ballots is supported.
Return	`boolean`		`true` if ballot search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBallotAdmin
Description	Tests if a ballot `a` dministrative service is supported.
Return	`boolean`		`true` if ballot administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBallotNotification
Description	Tests if a ballot notification service is supported.
Return	`boolean`		`true` if ballot notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBallotPolls
Description	Tests if retrieving mappings of ballots and polls is supported.
Return	`boolean`		`true` if ballot polls mapping retrieval is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBallotPollsAssignment
Description	Tests if managing mappings of ballots and polls is supported.
Return	`boolean`		`true` if ballot polls assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBallotSmartPolls
Description	Tests if ballot smart polls are available.
Return	`boolean`		`true` if ballot smart polls are supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPollsLookup
Description	Tests if polls lookup is supported.
Return	`boolean`		`true` if polls lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPollsQuery
Description	Tests if polls query is supported.
Return	`boolean`		`true` if polls query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPollsSearch
Description	Tests if polls search is supported.
Return	`boolean`		`true` if polls search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPollsAdmin
Description	Tests if polls administration is supported.
Return	`boolean`		`true` if polls administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPollsNotification
Description	Tests if polls notification is supported. Messages may be sent when `Polls` objects are created, deleted or updated. Notifications for candidates within polls are sent via the candidate notification session.
Return	`boolean`		`true` if polls notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPollsHierarchy
Description	Tests if a polls hierarchy traversal is supported.
Return	`boolean`		`true` if a polls hierarchy traversal is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPollsHierarchyDesign
Description	Tests if a polls hierarchy design is supported.
Return	`boolean`		`true` if a polls hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsVotingBatch
Description	Tests if a voting batch service is supported.
Return	`boolean`		`true` if a voting batch service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsVotingRules
Description	Tests if a voting rules service is supported.
Return	`boolean`		`true` if a voting rules service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getVoteRecordTypes
Description	Gets the supported `Vote` record types.
Return	`osid.type.TypeList`		a list containing the supported `Vote` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsVoteRecordType
Description	Tests if the given `Vote` record type is supported.
Parameters	`osid.type.Type`	`voteRecordType`	a `Type` indicating a `Vote` record type
Return	`boolean`		`true` if the given type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`voteRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getVoteSearchRecordTypes
Description	Gets the supported `Vote` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Vote` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsVoteSearchRecordType
Description	Tests if the given `Vote` search record type is supported.
Parameters	`osid.type.Type`	`voteSearchRecordType`	a `Type` indicating a `Vote` search record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`voteSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getVoterAllocationRecordTypes
Description	Gets the supported `VoterAllocation` record types.
Return	`osid.type.TypeList`		a list containing the supported `VoterAllocation` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsVoterAllocationRecordType
Description	Tests if the given `VoterAllocation` record type is supported.
Parameters	`osid.type.Type`	`voterAllocationRecordType`	a `Type` indicating a `VoterAllocation` record type
Return	`boolean`		`true` if the given type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`voterAllocationRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCandidateRecordTypes
Description	Gets all the candidate record types supported.
Return	`osid.type.TypeList`		the list of supported candidate record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCandidateRecordType
Description	Tests if a given candidate record type is supported.
Parameters	`osid.type.Type`	`candidateRecordType`	the candidate type
Return	`boolean`		`true` if the candidate record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`candidateRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCandidateSearchRecordTypes
Description	Gets all the candidate search record types supported.
Return	`osid.type.TypeList`		the list of supported candidate search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCandidateSearchRecordType
Description	Tests if a given candidate search type is supported.
Parameters	`osid.type.Type`	`candidateSearchRecordType`	the candidate search type
Return	`boolean`		`true` if the candidate search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`candidateSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRaceRecordTypes
Description	Gets the supported `Race` record types.
Return	`osid.type.TypeList`		a list containing the supported `Race` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRaceRecordType
Description	Tests if the given `Race` record type is supported.
Parameters	`osid.type.Type`	`raceRecordType`	a `Type` indicating a `Race` record type
Return	`boolean`		`true` if the given type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`raceRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRaceSearchRecordTypes
Description	Gets the supported `Race` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Race` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRaceSearchRecordType
Description	Tests if the given `Race` search record type is supported.
Parameters	`osid.type.Type`	`raceSearchRecordType`	a `Type` indicating a `Race` search record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`raceSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBallotRecordTypes
Description	Gets the supported `Ballot` record types.
Return	`osid.type.TypeList`		a list containing the supported `Ballot` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBallotRecordType
Description	Tests if the given `Ballot` record type is supported.
Parameters	`osid.type.Type`	`ballotRecordType`	a `Type` indicating a `Ballot` record type
Return	`boolean`		`true` if the given type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`ballotRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBallotSearchRecordTypes
Description	Gets the supported `Ballot` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Ballot` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBallotSearchRecordType
Description	Tests if the given `Ballot` search record type is supported.
Parameters	`osid.type.Type`	`ballotSearchRecordType`	a `Type` indicating a `Ballot` search record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`ballotSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getVotingResultsRecordTypes
Description	Gets the supported `VotingResults` record types.
Return	`osid.type.TypeList`		a list containing the supported `VotingResults` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsVotingResultsRecordType
Description	Tests if the given `VotingResults` record type is supported.
Parameters	`osid.type.Type`	`votingResultsRecordType`	a `Type` indicating a `VotingResults` record type
Return	`boolean`		`true` if the given type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`votingResultsRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPollsRecordTypes
Description	Gets all the polls record types supported.
Return	`osid.type.TypeList`		the list of supported polls record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPollsRecordType
Description	Tests if a given polls record type is supported.
Parameters	`osid.type.Type`	`pollsRecordType`	the polls record type
Return	`boolean`		`true` if the polls record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`pollsRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPollsSearchRecordTypes
Description	Gets all the polls search record types supported.
Return	`osid.type.TypeList`		the list of supported polls search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPollsSearchRecordType
Description	Tests if a given polls search record type is supported.
Parameters	`osid.type.Type`	`pollsSearchRecordType`	the polls search record type
Return	`boolean`		`true` if the polls search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`pollsSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.