OSID - osid.voting.CandidateAdminSession Service Interface Definition

Interface	osid.voting.CandidateAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Candidates.` The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Candidate,` a `CandidateForm` is requested using `getCandidateFormForCreate()` specifying the `Race` and desired record `Types` or none if no record `Types` are needed. The returned `CandidateForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `CandidateForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `CandidateForm` corresponds to an attempted transaction. For updates, `CandidateForms` are requested to the `Candidate` `Id` that is to be updated using `getCandidateFormForUpdate().` Similarly, the `CandidateForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `CandidateForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Candidates.` To unmap a `Candidate` from the current `Polls,` the `CandidatePollsAssignmentSession` should be used. These delete operations attempt to remove the `Candidate` itself thus removing it from all known `Polls` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
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	canCreateCandidates
Description	Tests if this user can create `Candidates.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Candidate` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `Candidate` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCandidateWithRecordTypes
Description	Tests if this user can create a single `Candidate` using the desired record types. While `VotingManager.getCandidateRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Candidate.` Providing an empty array tests if a `Candidate` can be created with no records.
Parameters	`osid.type.Type[]`	`candidateRecordTypes`	array of candidate record types
Return	`boolean`		`true` if `Candidate` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`candidateRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCandidateFormForCreate
Description	Gets the candidate form for creating new candidates. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`resourceId`	the resource Id
	`osid.id.Id`	`raceId`	the race Id
	`osid.type.Type[]`	`candidateRecordTypes`	array of candidate record types
Return	`osid.voting.CandidateForm`		the candidate form
Errors	NOT_FOUND		`resourceId` or `raceId` is not found
	NULL_ARGUMENT		`resourceId, raceId` or `candidateRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form with requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createCandidate
Description	Creates a new `Candidate.`
Parameters	`osid.voting.CandidateForm`	`candidateForm`	the form for this `Candidate`
Return	`osid.voting.Candidate`		the new `Candidate`
Errors	ILLEGAL_STATE		`candidateForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`candidateForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`candidateForm` did not originate from `getCandidateFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCandidates
Description	Tests if this user can update `Candidates.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Candidate` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `Candidate` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCandidateFormForUpdate
Description	Gets the candidate form for updating an existing candidate. A new candidate form should be requested for each update transaction.
Parameters	`osid.id.Id`	`candidateId`	the `Id` of the `Candidate`
Return	`osid.voting.CandidateForm`		the candidate form
Errors	NOT_FOUND		`candidateId` is not found
	NULL_ARGUMENT		`candidateId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCandidate
Description	Updates an existing candidate.
Parameters	`osid.voting.CandidateForm`	`candidateForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`candidateForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`candidateForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`candidateForm` did not originate from `getCandidateFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCandidates
Description	Tests if this user can delete `Candidates.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Candidate` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Candidate` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCandidate
Description	Deletes a `Candidate.`
Parameters	`osid.id.Id`	`candidateId`	the `Id` of the `Candidate` to remove
Errors	NOT_FOUND		`candidateId` not found
	NULL_ARGUMENT		`candidateId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCandidateAliases
Description	Tests if this user can manage `Id` aliases for `Candidates.` A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Candidate` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCandidate
Description	Adds an `Id` to a `Candidate` for the purpose of creating compatibility. The primary `Id` of the `Candidate` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another candidate it is reassigned to the given candidate `Id.`
Parameters	`osid.id.Id`	`candidateId`	the `Id` of a `Candidate`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`candidateId` not found
	NULL_ARGUMENT		`aliasId` or `candidateId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.