OSID - osid.metering.MeterAdminSession Service Interface Definition

Interface	osid.metering.MeterAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Meters.` 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 `Meter,` a `MeterForm` is requested using `getMeterFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `MeterForm` 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 `MeterForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `MeterForm` corresponds to an attempted transaction. For updates, `MeterForms` are requested to the `Meter` `Id` that is to be updated using `getMeterFormForUpdate().` Similarly, the `MeterForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `MeterForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Meters.` To unmap a `Meter` from the current `Utility,` the `MeterUtilityAssignmentSession` should be used. These delete operations attempt to remove the `Meter` itself thus removing it from all known `Utility` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getUtilityId
Description	Gets the `Utility` `Id` associated with this session.
Return	`osid.id.Id`		the `Utility Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getUtility
Description	Gets the `Utility` associated with this session.
Return	`osid.metering.Utility`		the `Utility` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateMeters
Description	Tests if this user can create `Meters` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Meter` 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 `Meter` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateMeterWithRecordTypes
Description	Tests if this user can create a single `Meter` using the desired record types. While `MeteringManager.getMeterRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Meter.` Providing an empty array tests if a `Meter` can be created with no records.
Parameters	`osid.type.Type[]`	`meterRecordTypes`	array of meter record types
Return	`boolean`		`true` if `Meter` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`meterRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getMeterFormForCreate
Description	Gets the meter form for creating new meters. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`meterRecordTypes`	array of meter record types
Return	`osid.metering.MeterForm`		the meter form
Errors	NULL_ARGUMENT		`meterRecordTypes` 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	createMeter
Description	Creates a new `Meter.`
Parameters	`osid.metering.MeterForm`	`meterForm`	the form for this `Meter`
Return	`osid.metering.Meter`		the new `Meter`
Errors	ILLEGAL_STATE		`meterForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`meterForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`meterForm` did not originate from `getMeterFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateMeters
Description	Tests if this user can update `Meters.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Meter` 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 `Meter` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMeterFormForUpdate
Description	Gets the meter form for updating an existing meter. A new meter form should be requested for each update transaction.
Parameters	`osid.id.Id`	`meterId`	the `Id` of the `Meter`
Return	`osid.metering.MeterForm`		the meter form
Errors	NOT_FOUND		`meterId` is not found
	NULL_ARGUMENT		`meterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateMeter
Description	Updates an existing meter.
Parameters	`osid.metering.MeterForm`	`meterForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`meterForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`meterForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`meterForm` did not originate from `getMeterFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteMeters
Description	Tests if this user can delete `Meters.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Meter` 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 `Meter` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteMeter
Description	Deletes a `Meter.`
Parameters	`osid.id.Id`	`meterId`	the `Id` of the `Meter` to remove
Errors	NOT_FOUND		`meterId` is not found
	NULL_ARGUMENT		`meterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageMeterAliases
Description	Tests if this user can manage `Id` aliases for `Meters.` 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 `Meter` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasMeter
Description	Adds an `Id` to a `Meter` for the purpose of creating compatibility. The primary `Id` of the `Meter` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another meter, it is reassigned to the given meter `Id.`
Parameters	`osid.id.Id`	`meterId`	the `Id` of a `Meter`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`meterId` not found
	NULL_ARGUMENT		`meterId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.