OSID - osid.voting.rules.BallotConstrainerAdminSession Service Interface Definition

Interface	osid.voting.rules.BallotConstrainerAdminSession
Implements	`osid.OsidSession`
Description	This session creates and removes ballot constrainers. The data for create and update is provided via the `BallotConstrainerForm.`
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	canCreateBallotConstrainer
Description	Tests if this user can create ballot constrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `BallotConstrainer` 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 `BallotConstrainer` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateBallotConstrainerWithRecordTypes
Description	Tests if this user can create a single `BallotConstrainer` using the desired record types. While `VotingRulesManager.getBallotConstrainerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `BallotConstrainer.` Providing an empty array tests if a `BallotConstrainer` can be created with no records.
Parameters	`osid.type.Type[]`	`ballotConstrainerRecordTypes`	array of ballot constrainer record types
Return	`boolean`		`true` if `BallotConstrainer` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`ballotConstrainerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainerFormForCreate
Description	Gets the ballot constrainer form for creating new ballot constrainers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`ballotConstrainerRecordTypes`	array of ballot constrainer record types
Return	`osid.voting.rules.BallotConstrainerForm`		the ballot constrainer form
Errors	NULL_ARGUMENT		`ballotConstrainerRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createBallotConstrainer
Description	Creates a new `BallotConstrainer.`
Parameters	`osid.voting.rules.BallotConstrainerForm`	`ballotConstrainerForm`	the form for this `BallotConstrainer`
Return	`osid.voting.rules.BallotConstrainer`		the new `BallotConstrainer`
Errors	ILLEGAL_STATE		`ballotConstrainerForm` already used for a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`ballotConstrainerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`ballotConstrainerForm` did not originate from `getBallotConstrainerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateBallotConstrainers
Description	Tests if this user can update ballot constrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `BallotConstrainer` 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 `BallotConstrainer` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainerFormForUpdate
Description	Gets the ballot constrainer form for updating an existing ballot constrainer. A new ballot constrainer form should be requested for each update transaction.
Parameters	`osid.id.Id`	`ballotConstrainerId`	the `Id` of the `BallotConstrainer`
Return	`osid.voting.rules.BallotConstrainerForm`		the ballot constrainer form
Errors	NOT_FOUND		`ballotConstrainerId` is not found
	NULL_ARGUMENT		`ballotConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateBallotConstrainer
Description	Updates an existing ballot constrainer.
Parameters	`osid.voting.rules.BallotConstrainerForm`	`ballotConstrainerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`ballotConstrainerForm` already used for an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`ballotConstrainerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`ballotConstrainerForm` did not originate from `getBallotConstrainerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteBallotConstrainers
Description	Tests if this user can delete ballot constrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `BallotConstrainer` 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 `BallotConstrainer` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteBallotConstrainer
Description	Deletes a `BallotConstrainer.`
Parameters	`osid.id.Id`	`ballotConstrainerId`	the `Id` of the `BallotConstrainer` to remove
Errors	NOT_FOUND		`ballotConstrainerId` not found
	NULL_ARGUMENT		`ballotConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageBallotConstrainerAliases
Description	Tests if this user can manage `Id` aliases for ballot constrainers. 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 `BallotConstrainer` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasBallotConstrainer
Description	Adds an `Id` to a `BallotConstrainer` for the purpose of creating compatibility. The primary `Id` of the `BallotConstrainer` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another ballot constrainer. it is reassigned to the given ballot constrainer `Id.`
Parameters	`osid.id.Id`	`ballotConstrainerId`	the `Id` of a `BallotConstrainer`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`ballotConstrainerId` not found
	NULL_ARGUMENT		`ballotConstrainerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.