OSID - osid.metering.UtilityAdminSession Service Interface Definition

Interface	osid.metering.UtilityAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Utilities.` 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 `UtilityForm,` a `UtilityForm` is requested using `getUtilityFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `UtilityForm` 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 `UtilityForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `UtilityForm` corresponds to an attempted transaction. For updates, `UtilityForms` are requested to the `Utility` `Id` that is to be updated using `getUtilityFormForUpdate().` Similarly, the `UtilityForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `UtilityForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Utilities.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateUtilities
Description	Tests if this user can create `Utilities.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Utility` 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 `Utility` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateUtilityWithRecordTypes
Description	Tests if this user can create a single `Utility` using the desired record interface types. While `MeteringManager.getUtilityRecordTypes()` can be used to examine which record interfaces are supported, this method tests which record(s) are required for creating a specific `Utility.` Providing an empty array tests if a `Utility` can be created with no records.
Parameters	`osid.type.Type[]`	`utilityRecordTypes`	array of utility record types
Return	`boolean`		`true` if `Utility` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`utilityRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getUtilityFormForCreate
Description	Gets the utility form for creating new utilities. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`utilityRecordTypes`	array of utility record types
Return	`osid.metering.UtilityForm`		the utility form
Errors	NULL_ARGUMENT		`utilityRecordTypes` 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	createUtility
Description	Creates a new `Utility.`
Parameters	`osid.metering.UtilityForm`	`utilityForm`	the form for this `Utility`
Return	`osid.metering.Utility`		the new `Utility`
Errors	ILLEGAL_STATE		`utilityForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`utilityForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`utilityForm` did not originate from `getUtilityFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateUtilities
Description	Tests if this user can update `Utilities.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Utility` 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 `Utility` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getUtilityFormForUpdate
Description	Gets the utility form for updating an existing utility. A new utility form should be requested for each update transaction.
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility`
Return	`osid.metering.UtilityForm`		the utility form
Errors	NOT_FOUND		`utilityId` is not found
	NULL_ARGUMENT		`utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateUtility
Description	Updates an existing utility.
Parameters	`osid.metering.UtilityForm`	`utilityForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`utilityForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`utilityForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`utilityForm` did not originate from `getUtilityFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteUtilities
Description	Tests if this user can delete `Utilities.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Utility` 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 `Utility` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteUtility
Description	Deletes a `Utility.`
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility` to remove
Errors	NOT_FOUND		`utilityId` not found
	NULL_ARGUMENT		`utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageUtilityAliases
Description	Tests if this user can manage `Id` aliases for utilities. 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 `Utility` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasUtility
Description	Adds an `Id` to a `Utility` for the purpose of creating compatibility. The primary `Id` of the `Utility` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another event, it is reassigned to the given event `Id.`
Parameters	`osid.id.Id`	`utilityId`	the `Id` of a `Utility`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`utilityId` not found
	NULL_ARGUMENT		`utilityId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.