OSID - osid.voting.PollsAdminSession Service Interface Definition

Interface	osid.voting.PollsAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Polls.` 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 `Polls,` a `PollsForm` is requested using `getPollsFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `PollsForm` 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 `PollsForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `PollsForm` corresponds to an attempted transaction. For updates, `PollsForms` are requested to the `Polls` `Id` that is to be updated using `getPollsFormForUpdate().` Similarly, the `PollsForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `PollsForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Polls.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreatePolls
Description	Tests if this user can create `Polls.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Polls` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `Polls` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreatePollsWithRecordTypes
Description	Tests if this user can create a single `Polls` using the desired record types. While `VotingManager.getPollsRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Polls.` Providing an empty array tests if a `Polls` can be created with no records.
Parameters	`osid.type.Type[]`	`pollsRecordTypes`	array of polls record types
Return	`boolean`		`true` if `Polls` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`pollsRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPollsFormForCreate
Description	Gets the polls form for creating new polls.
Parameters	`osid.type.Type[]`	`pollsRecordTypes`	array of polls record types
Return	`osid.voting.PollsForm`		the polls form
Errors	NULL_ARGUMENT		`pollsRecordTypes` 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	createPolls
Description	Creates a new `Polls.`
Parameters	`osid.voting.PollsForm`	`pollsForm`	the form for this `Polls`
Return	`osid.voting.Polls`		the new `Polls`
Errors	ILLEGAL_STATE		`pollsForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`pollsForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`pollsForm` did not originate from `getPollsFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdatePolls
Description	Tests if this user can update `Polls.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Polls` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `Polls` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPollsFormForUpdate
Description	Gets the polls form for updating an existing polls. A new polls form should be requested for each update transaction.
Parameters	`osid.id.Id`	`pollsId`	the `Id` of the `Polls`
Return	`osid.voting.PollsForm`		the polls form
Errors	NOT_FOUND		`pollsId` is not found
	NULL_ARGUMENT		`pollsId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updatePolls
Description	Updates an existing polls.
Parameters	`osid.voting.PollsForm`	`pollsForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`pollsForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`pollsId` or `pollsForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`pollsForm` did not originate from `getPollsFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeletePolls
Description	Tests if this user can delete `Polls.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Polls` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `Polls` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deletePolls
Description	Deletes a `Polls.`
Parameters	`osid.id.Id`	`pollsId`	the `Id` of the `Polls` to remove
Errors	NOT_FOUND		`pollsId` not found
	NULL_ARGUMENT		`pollsId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManagePollsAliases
Description	Tests if this user can manage `Id` aliases for `Polls.` 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 `Polls` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasPolls
Description	Adds an `Id` to a `Polls` for the purpose of creating compatibility. The primary `Id` of the `Polls` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another polls, it is reassigned to the given polls `Id.`
Parameters	`osid.id.Id`	`pollsId`	the `Id` of a `Polls`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`pollsId` not found
	NULL_ARGUMENT		`pollsId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.