OSID - osid.voting.CandidateNotificationSession Service Interface Definition

Interface	osid.voting.CandidateNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Candidate` objects in this `Polls.` This also includes existing candidates that may appear or disappear due to changes in the `Polls` hierarchy, 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 two views defined in this session correspond to the views in the `CandidateLookupSession.`
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` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForCandidateNotifications
Description	Tests if this user can register for `Candidate` 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 candidates 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 to this polls only.
Compliance	`mandatory`		This method is must be implemented.
Method	registerForNewCandidates
Description	Register for notifications of new candidates. `CandidateReceiver.newCandidates()` is invoked when a new `Candidate` is appears in this polls.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewCandidatesForResource
Description	Registers for notification of a new candidate for the given resource. `CandidateReceiver.newCandidates()` is invoked when the specified candidate is created in this polls.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` 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	registerForNewCandidatesForRace
Description	Registers for notification of a new candidate for the given race. `CandidateReceiver.newCandidates()` is invoked when the specified candidate is created in this polls.
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	registerForChangedCandidates
Description	Registers for notification of updated candidates. `CandidateReceiver.changedCandidates()` is invoked when a candidate in this polls is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCandidatesForResource
Description	Registers for notification of an updated candidate for the given resource. `CandidateReceiver.changedCandidates()` is invoked when the specified candidate is updated in this polls.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` 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	registerForChangedCandidatesForRace
Description	Registers for notification of an updated candidate for the given race. `CandidateReceiver.changedCandidates()` is invoked when the specified candidate is updated in this polls.
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	registerForChangedCandidate
Description	Registers for notification of an updated candidate. `CandidateReceiver.changedCandidates()` is invoked when the specified candidate in this polls 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	registerForDeletedCandidates
Description	Registers for notification of deleted candidates. `CandidateReceiver.deletedCandidates()` is invoked when a candidate is deleted or removed from this polls.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCandidatesForResource
Description	Registers for notification of a deleted candidate for the given resource. `CandidateReceiver.deletedCandidates()` is invoked when the specified candidate is deleted or removed from this polls.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` 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	registerForDeletedCandidatesForRace
Description	Registers for notification of a deleted candidate for the given race. `CandidateReceiver.deletedCandidates()` is invoked when the specified candidate is deleted or removed from this polls.
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	registerForDeletedCandidate
Description	Registers for notification of a deleted candidate. `CandidateReceiver.deletedCandidates()` is invoked when the specified candidate is deleted or removed from this polls.
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.