Interface | osid.metering.batch.UtilityBatchAdminSession | ||
---|---|---|---|
Implements | osid.metering.UtilityAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getUtilityFormsForCreate | ||
Description |
Gets the utility forms for creating a bunch of new utilities. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | utilityRecordTypes | array of utility record types to be included in each create operation or an empty list if none | |
Return | osid.metering.batch.UtilityBatchFormList | the utility forms | |
Errors | NULL_ARGUMENT | utilityRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createUtilities | ||
Description |
Creates a new set of | ||
Parameters | osid.metering.batch.UtilityBatchFormList | utilityForms | the utility forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | utilityForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getUtilityFormsForUpdate | ||
Description |
Gets the utility forms for updating an existing set of utilities. A new utility form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | utilityIds | the Ids of the Utility |
Return | osid.metering.batch.UtilityBatchFormList | the utility form | |
Errors | NOT_FOUND | a utilityId is not found | |
NULL_ARGUMENT | utilityIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateUtilities | ||
Description |
Updates existing utilities. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.metering.batch.UtilityBatchFormList | utilityForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | utilityForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllUtilities | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteUtilities | ||
Description |
Deletes utilities for the given | ||
Parameters | osid.id.IdList | utilityIds | the Ids of the utilities to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | utilityIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasUtilities | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |