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

Interface	osid.voting.rules.VoteEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.voting.rules.VotingRulesManager`
Used By	`osid.voting.rules.VotingRulesProxyManager`
Description	This session creates, updates, and deletes `VoteEnablers` . 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 `VoteEnabler` , a `VoteEnablerForm` is requested using `getVoteEnablerFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `VoteEnablerForm` 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 `VoteEnablerForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `VoteEnablerForm` corresponds to an attempted transaction. For updates, `VoteEnablerForms` are requested to the `VoteEnabler` `Id` that is to be updated using `getVoteEnablerFormForUpdate()` . Similarly, the `VoteEnablerForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `VoteEnablerForm` can only be used once for a successful update and cannot be reused. The delete operations delete `VoteEnablers` . To unmap a `VoteEnabler` from the current `Polls` , the `VoteEnablerPollsAssignmentSession` should be used. These delete operations attempt to remove the `VoteEnabler` 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
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateVoteEnablers
Description	Tests if this user can create `VoteEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `VoteEnabler` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `VoteEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateVoteEnablerWithRecordTypes
Description	Tests if this user can create a single `VoteEnabler` using the desired record types. While `VotingRulesManager.getVoteEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `VoteEnabler` . Providing an empty array tests if a `VoteEnabler can be cre` ated with no records.
Parameters	`osid.type.Type[]`	`voteEnablerRecordTypes`	array of vote enabler record types
Return	`boolean`		`true` if `VoteEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`voteEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getVoteEnablerFormForCreate
Description	Gets the vote enabler form for creating new vote enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`voteEnablerRecordTypes`	array of vote enabler record types
Return	`osid.voting.rules.VoteEnablerForm`		the vote enabler form
Errors	NULL_ARGUMENT		`voteEnablerRecordTypes` 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	createVoteEnabler
Description	Creates a new `VoteEnabler` .
Parameters	`osid.voting.rules.VoteEnablerForm`	`voteEnablerForm`	the form for this `VoteEnabler`
Return	`osid.voting.rules.VoteEnabler`		the new `VoteEnabler`
Errors	ILLEGAL_STATE		`voteEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`voteEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`voteEnablerForm` did not originate from `getVoteEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateVoteEnablers
Description	Tests if this user can update `VoteEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `VoteEnabler` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `VoteEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getVoteEnablerFormForUpdate
Description	Gets the vote enabler form for updating an existing vote enabler. A new vote enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`voteEnablerId`	the `Id` of the `VoteEnabler`
Return	`osid.voting.rules.VoteEnablerForm`		the vote enabler form
Errors	NOT_FOUND		`voteEnablerId` is not found
	NULL_ARGUMENT		`voteEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateVoteEnabler
Description	Updates an existing vote enabler.
Parameters	`osid.voting.rules.VoteEnablerForm`	`voteEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`voteEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`voteEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`voteEnablerForm` did not originate from `getVoteEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteVoteEnablers
Description	Tests if this user can delete `VoteEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `VoteEnabler` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `VoteEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteVoteEnabler
Description	Deletes a `VoteEnabler` .
Parameters	`osid.id.Id`	`voteEnablerId`	the `Id` of the `VoteEnabler` to remove
Errors	NOT_FOUND		`voteEnablerId` not found
	NULL_ARGUMENT		`voteEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageVoteEnablerAliases
Description	Tests if this user can manage `Id` aliases for `VoteEnablers` 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 `VoteEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasVoteEnabler
Description	Adds an `Id` to a `VoteEnabler` for the purpose of creating compatibility. The primary `Id` of the `VoteEnabler` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another vote enabler, it is reassigned to the given vote enabler `Id` .
Parameters	`osid.id.Id`	`voteEnablerId`	the `Id` of a `VoteEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`voteEnablerId` not found
	NULL_ARGUMENT		`voteEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.