org.osid.voting

Interface VotingProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

VotingManager, VotingProxyManager

public interface VotingProfile
extends OsidProfile

The voting profile describes interoperability among voting services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getBallotRecordTypes() Gets the supported Ballot record types.
TypeList	getBallotSearchRecordTypes() Gets the supported Ballot search record types.
TypeList	getCandidateRecordTypes() Gets all the candidate record types supported.
TypeList	getCandidateSearchRecordTypes() Gets all the candidate search record types supported.
TypeList	getPollsRecordTypes() Gets all the polls record types supported.
TypeList	getPollsSearchRecordTypes() Gets all the polls search record types supported.
TypeList	getRaceRecordTypes() Gets the supported Race record types.
TypeList	getRaceSearchRecordTypes() Gets the supported Race search record types.
TypeList	getVoterAllocationRecordTypes() Gets the supported VoterAllocation record types.
TypeList	getVoteRecordTypes() Gets the supported Vote record types.
TypeList	getVoteSearchRecordTypes() Gets the supported Vote search record types.
TypeList	getVotingResultsRecordTypes() Gets the supported VotingResults record types.
boolean	supportsBallotAdmin() Tests if a ballot a dministrative service is supported.
boolean	supportsBallotLookup() Tests if looking up ballots is supported.
boolean	supportsBallotNotification() Tests if a ballot notification service is supported.
boolean	supportsBallotPolls() Tests if retrieving mappings of ballots and polls is supported.
boolean	supportsBallotPollsAssignment() Tests if managing mappings of ballots and polls is supported.
boolean	supportsBallotQuery() Tests if querying ballots is supported.
boolean	supportsBallotRecordType(Type ballotRecordType) Tests if the given Ballot record type is supported.
boolean	supportsBallotSearch() Tests if searching ballots is supported.
boolean	supportsBallotSearchRecordType(Type ballotSearchRecordType) Tests if the given Ballot search record type is supported.
boolean	supportsBallotSmartPolls() Tests if ballot smart polls are available.
boolean	supportsCandidateAdmin() Tests if candidate administration is supported.
boolean	supportsCandidateLookup() Tests if candidate lookup is supported.
boolean	supportsCandidateNotification() Tests if candidate notification is supported.
boolean	supportsCandidatePolls() Tests if retrieving mappings of candidate and polls is supported.
boolean	supportsCandidatePollsAssignment() Tests if managing mappings of candidate and polls is supported.
boolean	supportsCandidateQuery() Tests if candidate query is supported.
boolean	supportsCandidateRecordType(Type candidateRecordType) Tests if a given candidate record type is supported.
boolean	supportsCandidateSearch() Tests if candidate search is supported.
boolean	supportsCandidateSearchRecordType(Type candidateSearchRecordType) Tests if a given candidate search type is supported.
boolean	supportsCandidateSmartPolls() Tests if candidate smart polls are available.
boolean	supportsPollsAdmin() Tests if polls administration is supported.
boolean	supportsPollsHierarchy() Tests if a polls hierarchy traversal is supported.
boolean	supportsPollsHierarchyDesign() Tests if a polls hierarchy design is supported.
boolean	supportsPollsLookup() Tests if polls lookup is supported.
boolean	supportsPollsNotification() Tests if polls notification is supported.
boolean	supportsPollsQuery() Tests if polls query is supported.
boolean	supportsPollsRecordType(Type pollsRecordType) Tests if a given polls record type is supported.
boolean	supportsPollsSearch() Tests if polls search is supported.
boolean	supportsPollsSearchRecordType(Type pollsSearchRecordType) Tests if a given polls search record type is supported.
boolean	supportsRaceAdmin() Tests if a race a dministrative service is supported.
boolean	supportsRaceLookup() Tests if looking up races is supported.
boolean	supportsRaceNotification() Tests if a race notification service is supported.
boolean	supportsRacePolls() Tests if retrieving mappings of races and polls is supported.
boolean	supportsRacePollsAssignment() Tests if managing mappings of races and polls is supported.
boolean	supportsRaceQuery() Tests if querying races is supported.
boolean	supportsRaceRecordType(Type raceRecordType) Tests if the given Race record type is supported.
boolean	supportsRaceResults() Tests if race results is supported.
boolean	supportsRaceSearch() Tests if searching races is supported.
boolean	supportsRaceSearchRecordType(Type raceSearchRecordType) Tests if the given Race search record type is supported.
boolean	supportsRaceSmartPolls() Tests if race smart polls are available.
boolean	supportsVisibleFederation() Tests if federation is visible.
boolean	supportsVoteLookup() Tests if looking up votes is supported.
boolean	supportsVoteNotification() Tests if a votes notification service is supported.
boolean	supportsVotePolls() Tests if retrieving mappings of votes and polls is supported.
boolean	supportsVotePollsAssignment() Tests if managing mappings of votes and polls is supported.
boolean	supportsVoteQuery() Tests if querying votes is supported.
boolean	supportsVoterAllocationRecordType(Type voterAllocationRecordType) Tests if the given VoterAllocation record type is supported.
boolean	supportsVoteRecordType(Type voteRecordType) Tests if the given Vote record type is supported.
boolean	supportsVoteSearch() Tests if searching votes is supported.
boolean	supportsVoteSearchRecordType(Type voteSearchRecordType) Tests if the given Vote search record type is supported.
boolean	supportsVoteSmartPolls() Tests if vote smart polls are available.
boolean	supportsVoting() Tests if voting is supported.
boolean	supportsVotingAllocationAdmin() Tests if voting allocation administration is supported.
boolean	supportsVotingAllocationLookup() Tests if voting allocation lookup is supported.
boolean	supportsVotingBatch() Tests if a voting batch service is supported.
boolean	supportsVotingResultsRecordType(Type votingResultsRecordType) Tests if the given VotingResults record type is supported.
boolean	supportsVotingRules() Tests if a voting rules service is supported.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

Tests if federation is visible.

Returns:

true if visible federation is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsVoting

boolean supportsVoting()

Tests if voting is supported.

Returns:

true if voting is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRaceResults

boolean supportsRaceResults()

Tests if race results is supported.

Returns:

true if race results is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsVotingAllocationLookup

boolean supportsVotingAllocationLookup()

Tests if voting allocation lookup is supported.

Returns:

true if voting allocation lookup is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsVotingAllocationAdmin

boolean supportsVotingAllocationAdmin()

Tests if voting allocation administration is supported.

Returns:

true if voting allocation administration is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsVoteLookup

boolean supportsVoteLookup()

Tests if looking up votes is supported.

Returns:

true if votes lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsVoteQuery

boolean supportsVoteQuery()

Tests if querying votes is supported.

Returns:

true if votes query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsVoteSearch

boolean supportsVoteSearch()

Tests if searching votes is supported.

Returns:

true if votes search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsVoteNotification

boolean supportsVoteNotification()

Tests if a votes notification service is supported.

Returns:

true if votes notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsVotePolls

boolean supportsVotePolls()

Tests if retrieving mappings of votes and polls is supported.

Returns:

true if vote polls mapping retrieval is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsVotePollsAssignment

boolean supportsVotePollsAssignment()

Tests if managing mappings of votes and polls is supported.

Returns:

true if vote polls assignment is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsVoteSmartPolls

boolean supportsVoteSmartPolls()

Tests if vote smart polls are available.

Returns:

true if vote smart polls are supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCandidateLookup

boolean supportsCandidateLookup()

Tests if candidate lookup is supported.

Returns:

true if candidate lookup is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCandidateQuery

boolean supportsCandidateQuery()

Tests if candidate query is supported.

Returns:

true if candidate query is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCandidateSearch

boolean supportsCandidateSearch()

Tests if candidate search is supported.

Returns:

true if candidate search is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCandidateAdmin

boolean supportsCandidateAdmin()

Tests if candidate administration is supported.

Returns:

true if candidate administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCandidateNotification

boolean supportsCandidateNotification()

Tests if candidate notification is supported. Messages may be sent when candidates are created, modified, or deleted.

Returns:

true if candidate notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCandidatePolls

boolean supportsCandidatePolls()

Tests if retrieving mappings of candidate and polls is supported.

Returns:

true if candidate polls mapping retrieval is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCandidatePollsAssignment

boolean supportsCandidatePollsAssignment()

Tests if managing mappings of candidate and polls is supported.

Returns:

true if candidate polls assignment is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCandidateSmartPolls

boolean supportsCandidateSmartPolls()

Tests if candidate smart polls are available.

Returns:

true if candidate smart polls are supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRaceLookup

boolean supportsRaceLookup()

Tests if looking up races is supported.

Returns:

true if race lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRaceQuery

boolean supportsRaceQuery()

Tests if querying races is supported.

Returns:

true if race query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRaceSearch

boolean supportsRaceSearch()

Tests if searching races is supported.

Returns:

true if races search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRaceAdmin

boolean supportsRaceAdmin()

Tests if a race a dministrative service is supported.

Returns:

true if race administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRaceNotification

boolean supportsRaceNotification()

Tests if a race notification service is supported.

Returns:

true if race notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRacePolls

boolean supportsRacePolls()

Tests if retrieving mappings of races and polls is supported.

Returns:

true if race polls mapping retrieval is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRacePollsAssignment

boolean supportsRacePollsAssignment()

Tests if managing mappings of races and polls is supported.

Returns:

true if race polls assignment is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRaceSmartPolls

boolean supportsRaceSmartPolls()

Tests if race smart polls are available.

Returns:

true if race smart polls are supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBallotLookup

boolean supportsBallotLookup()

Tests if looking up ballots is supported.

Returns:

true if ballot lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBallotQuery

boolean supportsBallotQuery()

Tests if querying ballots is supported.

Returns:

true if ballot query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBallotSearch

boolean supportsBallotSearch()

Tests if searching ballots is supported.

Returns:

true if ballot search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBallotAdmin

boolean supportsBallotAdmin()

Tests if a ballot a dministrative service is supported.

Returns:

true if ballot administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBallotNotification

boolean supportsBallotNotification()

Tests if a ballot notification service is supported.

Returns:

true if ballot notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBallotPolls

boolean supportsBallotPolls()

Tests if retrieving mappings of ballots and polls is supported.

Returns:

true if ballot polls mapping retrieval is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBallotPollsAssignment

boolean supportsBallotPollsAssignment()

Tests if managing mappings of ballots and polls is supported.

Returns:

true if ballot polls assignment is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBallotSmartPolls

boolean supportsBallotSmartPolls()

Tests if ballot smart polls are available.

Returns:

true if ballot smart polls are supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPollsLookup

boolean supportsPollsLookup()

Tests if polls lookup is supported.

Returns:

true if polls lookup is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPollsQuery

boolean supportsPollsQuery()

Tests if polls query is supported.

Returns:

true if polls query is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPollsSearch

boolean supportsPollsSearch()

Tests if polls search is supported.

Returns:

true if polls search is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPollsAdmin

boolean supportsPollsAdmin()

Tests if polls administration is supported.

Returns:

true if polls administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPollsNotification

boolean supportsPollsNotification()

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.

Returns:

true if polls notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPollsHierarchy

boolean supportsPollsHierarchy()

Tests if a polls hierarchy traversal is supported.

Returns:

true if a polls hierarchy traversal is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPollsHierarchyDesign

boolean supportsPollsHierarchyDesign()

Tests if a polls hierarchy design is supported.

Returns:

true if a polls hierarchy design is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsVotingBatch

boolean supportsVotingBatch()

Tests if a voting batch service is supported.

Returns:

true if a voting batch service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsVotingRules

boolean supportsVotingRules()

Tests if a voting rules service is supported.

Returns:

true if a voting rules service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getVoteRecordTypes

TypeList getVoteRecordTypes()

Gets the supported Vote record types.

Returns:

a list containing the supported Vote record types

Compliance:

mandatory - This method must be implemented.

supportsVoteRecordType

boolean supportsVoteRecordType(Type voteRecordType)

Tests if the given Vote record type is supported.

Parameters:

voteRecordType - a Type indicating a Vote record type

Returns:

true if the given type is supported, false otherwise

Throws:

NullArgumentException - voteRecordType is null

Compliance:

mandatory - This method must be implemented.

getVoteSearchRecordTypes

TypeList getVoteSearchRecordTypes()

Gets the supported Vote search record types.

Returns:

a list containing the supported Vote search record types

Compliance:

mandatory - This method must be implemented.

supportsVoteSearchRecordType

boolean supportsVoteSearchRecordType(Type voteSearchRecordType)

Tests if the given Vote search record type is supported.

Parameters:

voteSearchRecordType - a Type indicating a Vote search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - voteSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getVoterAllocationRecordTypes

TypeList getVoterAllocationRecordTypes()

Gets the supported VoterAllocation record types.

Returns:

a list containing the supported VoterAllocation record types

Compliance:

mandatory - This method must be implemented.

supportsVoterAllocationRecordType

boolean supportsVoterAllocationRecordType(Type voterAllocationRecordType)

Tests if the given VoterAllocation record type is supported.

Parameters:

voterAllocationRecordType - a Type indicating a VoterAllocation record type

Returns:

true if the given type is supported, false otherwise

Throws:

NullArgumentException - voterAllocationRecordType is null

Compliance:

mandatory - This method must be implemented.

getCandidateRecordTypes

TypeList getCandidateRecordTypes()

Gets all the candidate record types supported.

Returns:

the list of supported candidate record types

Compliance:

mandatory - This method must be implemented.

supportsCandidateRecordType

boolean supportsCandidateRecordType(Type candidateRecordType)

Tests if a given candidate record type is supported.

Parameters:

candidateRecordType - the candidate type

Returns:

true if the candidate record type is supported , false otherwise

Throws:

NullArgumentException - candidateRecordType is null

Compliance:

mandatory - This method must be implemented.

getCandidateSearchRecordTypes

TypeList getCandidateSearchRecordTypes()

Gets all the candidate search record types supported.

Returns:

the list of supported candidate search record types

Compliance:

mandatory - This method must be implemented.

supportsCandidateSearchRecordType

boolean supportsCandidateSearchRecordType(Type candidateSearchRecordType)

Tests if a given candidate search type is supported.

Parameters:

candidateSearchRecordType - the candidate search type

Returns:

true if the candidate search record type is supported , false otherwise

Throws:

NullArgumentException - candidateSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getRaceRecordTypes

TypeList getRaceRecordTypes()

Gets the supported Race record types.

Returns:

a list containing the supported Race record types

Compliance:

mandatory - This method must be implemented.

supportsRaceRecordType

boolean supportsRaceRecordType(Type raceRecordType)

Tests if the given Race record type is supported.

Parameters:

raceRecordType - a Type indicating a Race record type

Returns:

true if the given type is supported, false otherwise

Throws:

NullArgumentException - raceRecordType is null

Compliance:

mandatory - This method must be implemented.

getRaceSearchRecordTypes

TypeList getRaceSearchRecordTypes()

Gets the supported Race search record types.

Returns:

a list containing the supported Race search record types

Compliance:

mandatory - This method must be implemented.

supportsRaceSearchRecordType

boolean supportsRaceSearchRecordType(Type raceSearchRecordType)

Tests if the given Race search record type is supported.

Parameters:

raceSearchRecordType - a Type indicating a Race search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - raceSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getBallotRecordTypes

TypeList getBallotRecordTypes()

Gets the supported Ballot record types.

Returns:

a list containing the supported Ballot record types

Compliance:

mandatory - This method must be implemented.

supportsBallotRecordType

boolean supportsBallotRecordType(Type ballotRecordType)

Tests if the given Ballot record type is supported.

Parameters:

ballotRecordType - a Type indicating a Ballot record type

Returns:

true if the given type is supported, false otherwise

Throws:

NullArgumentException - ballotRecordType is null

Compliance:

mandatory - This method must be implemented.

getBallotSearchRecordTypes

TypeList getBallotSearchRecordTypes()

Gets the supported Ballot search record types.

Returns:

a list containing the supported Ballot search record types

Compliance:

mandatory - This method must be implemented.

supportsBallotSearchRecordType

boolean supportsBallotSearchRecordType(Type ballotSearchRecordType)

Tests if the given Ballot search record type is supported.

Parameters:

ballotSearchRecordType - a Type indicating a Ballot search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - ballotSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getVotingResultsRecordTypes

TypeList getVotingResultsRecordTypes()

Gets the supported VotingResults record types.

Returns:

a list containing the supported VotingResults record types

Compliance:

mandatory - This method must be implemented.

supportsVotingResultsRecordType

boolean supportsVotingResultsRecordType(Type votingResultsRecordType)

Tests if the given VotingResults record type is supported.

Parameters:

votingResultsRecordType - a Type indicating a VotingResults record type

Returns:

true if the given type is supported, false otherwise

Throws:

NullArgumentException - votingResultsRecordType is null

Compliance:

mandatory - This method must be implemented.

getPollsRecordTypes

TypeList getPollsRecordTypes()

Gets all the polls record types supported.

Returns:

the list of supported polls record types

Compliance:

mandatory - This method must be implemented.

supportsPollsRecordType

boolean supportsPollsRecordType(Type pollsRecordType)

Tests if a given polls record type is supported.

Parameters:

pollsRecordType - the polls record type

Returns:

true if the polls record type is supported , false otherwise

Throws:

NullArgumentException - pollsRecordType is null

Compliance:

mandatory - This method must be implemented.

getPollsSearchRecordTypes

TypeList getPollsSearchRecordTypes()

Gets all the polls search record types supported.

Returns:

the list of supported polls search record types

Compliance:

mandatory - This method must be implemented.

supportsPollsSearchRecordType

boolean supportsPollsSearchRecordType(Type pollsSearchRecordType)

Tests if a given polls search record type is supported.

Parameters:

pollsSearchRecordType - the polls search record type

Returns:

true if the polls search record type is supported , false otherwise

Throws:

NullArgumentException - pollsSearchRecordType is null

Compliance:

mandatory - This method must be implemented.