OSID - osid.voting.VoteNotificationSession Service Interface Definition

Interface	osid.voting.VoteNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.voting.VotingManager`
Used By	`osid.voting.VotingProxyManager`
Description	This session defines methods to receive asynchronous notifications on adds/changes to votes. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed. The views defined in this session correspond to the views in the `VoteLookupSession`.
Method	getPollsId
Description	Gets the `Polls` `Id` associated with this session.
Return	`osid.id.Id`		the `Polls Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getPolls
Description	Gets the `Polls` associated with this session.
Return	`osid.voting.Polls`		the polls
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForVoteNotifications
Description	Tests if this user can register for `Vote` notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer notification operations.
Return	`boolean`		`false` if notification methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedPollsView
Description	Federates the view for methods in this session. A federated view will include notifications for votes in polls which are children of this polls in the polls hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedPollsView
Description	Isolates the view for methods in this session. An isolated view restricts notifications for votes in this polls only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableVoteNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeVoteNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableVoteNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeVoteNotification
Description	Acknowledge a vote notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewVotes
Description	Register for notifications of new votes. `VoteReceiver.newVotes()` is invoked when a new vote is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewVotesForBallot
Description	Register for notifications of new votes for the given ballot. `VoteReceiver.newVotes()` is invoked when a new vote is created.
Parameters	`osid.id.Id`	`ballotId`	the `Id` of the `Ballot` to monitor
Errors	NULL_ARGUMENT		`ballotId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewVotesForRace
Description	Register for notifications of new votes for the given race. `VoteReceiver.newVotes()` is invoked when a new vote is created.
Parameters	`osid.id.Id`	`raceId`	the `Id` of the `Race` to monitor
Errors	NULL_ARGUMENT		`raceId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewVotesForCandidate
Description	Register for notifications of new votes for the given candidate. `VoteReceiver.newVotes()` is invoked when a new vote is created.
Parameters	`osid.id.Id`	`candidateId`	the `Id` of the `Candidate` to monitor
Errors	NULL_ARGUMENT		`candidateId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewVotesForVoter
Description	Register for notifications of new votes for the given voter. `VoteReceiver.newVotes()` is invoked when a new vote is created.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the voter to monitor
Errors	NULL_ARGUMENT		`resourceId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedVotes
Description	Registers for notification of updated votes. `VoteReceiver.ChangedVotes()` is invoked when a vote is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedVotesForBallot
Description	Register for notifications of updated votes for the given ballot. `VoteReceiver.changedVotes()` is invoked when a vote is changed.
Parameters	`osid.id.Id`	`ballotId`	the `Id` of the `Ballot` to monitor
Errors	NULL_ARGUMENT		`ballotId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedVotesForRace
Description	Register for notifications of updated votes for the given race. `VoteReceiver.changedVotes()` is invoked when a vote is changed.
Parameters	`osid.id.Id`	`raceId`	the `Id` of the `Race` to monitor
Errors	NULL_ARGUMENT		`raceId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedVotesForCandidate
Description	Register for notifications of updated votes for the given candidate. `VoteReceiver.changedVotes()` is invoked when a vote is changed.
Parameters	`osid.id.Id`	`candidateId`	the `Id` of the `Candidate` to monitor
Errors	NULL_ARGUMENT		`candidateId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedVotesForVoter
Description	Register for notifications of updated votes for the given voter. `VoteReceiver.changedVotes()` is invoked when a vote is changed.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the voter to monitor
Errors	NULL_ARGUMENT		`resourceId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedVote
Description	Register for notifications of updated votes for the given vote. `VoteReceiver.changedVotes()` is invoked when a vote is changed.
Parameters	`osid.id.Id`	`voteId`	the `Id` of the `Vote` to monitor
Errors	NULL_ARGUMENT		`voteId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedVotes
Description	Registers for notification of deleted votes. `VoteReceiver.deletedVotes()` is invoked when a vote is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedVotesForBallot
Description	Register for notifications of deleted votes for the given ballot. `VoteReceiver.deletedVotes()` is invoked when a vote is deleted.
Parameters	`osid.id.Id`	`ballotId`	the `Id` of the `Ballot` to monitor
Errors	NULL_ARGUMENT		`ballotId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedVotesForRace
Description	Register for notifications of deleted votes for the given race. `VoteReceiver.deletedVotes()` is invoked when a vote is deleted.
Parameters	`osid.id.Id`	`raceId`	the `Id` of the `Race` to monitor
Errors	NULL_ARGUMENT		`raceId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedVotesForCandidate
Description	Register for notifications of deleted votes for the given candidate. `VoteReceiver.deletedVotes()` is invoked when a vote is deleted.
Parameters	`osid.id.Id`	`candidateId`	the `Id` of the `Candidate` to monitor
Errors	NULL_ARGUMENT		`candidateId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedVotesForVoter
Description	Register for notifications of deleted votes for the given voter. `VoteReceiver.deletedVotes()` is invoked when a vote is deleted.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the voter to monitor
Errors	NULL_ARGUMENT		`resourceId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedVote
Description	Registers for notification of a deleted vote. `VoteReceiver.changedVotes()` is invoked when the specified vote is deleted.
Parameters	`osid.id.Id`	`voteId`	the `Id` of the `Vote` to monitor
Errors	NULL_ARGUMENT		`voteId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.