OSID Logo
OSID Specifications
metering batch package
Version 3.1.0
Interfaceosid.metering.batch.UtilityBatchForm
Implementsosid.metering.UtilityForm
Used Byosid.metering.batch.UtilityBatchFormList
Description

This is the form for creating and updating utilities in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the UtilityBatchAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetUtilityId
Description

Gets the Utility Id of the utility to be updated if this is an update transaction.

Returnosid.id.Id the utility Id
ErrorsILLEGAL_STATE isForUpdate() is false
Compliancemandatory This method must be implemented.
MethodgetParentsMetadata
Description

Gets the metadata for setting the hierarchical parents of this utility.

Returnosid.Metadata metadata for the parents
Compliancemandatory This method must be implemented.
MethodsetParents
Description

Sets the hierarchical parents.

Parametersosid.id.Id[]parents the new parents
ErrorsINVALID_ARGUMENT parents is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT parents is null
Compliancemandatory This method must be implemented.
MethodclearParents
Description

Removes the hierarchical parents.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
Compliancemandatory This method must be implemented.