OSID Logo
OSID Specifications
billing package
Version 3.1.0
Interfaceosid.billing.CustomerForm
Implementsosid.OsidObjectForm
osid.OsidTemporalForm
Implemented Byosid.billing.batch.CustomerBatchForm
Used Byosid.billing.CustomerAdminSession
Description

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

MethodgetCustomerNumberMetadata
Description

Gets the metadata for the customer number.

Returnosid.Metadata metadata for the customer number
Compliancemandatory This method must be implemented.
MethodsetCustomerNumber
Description

Sets the customer number.

Parametersstringnumber the new number
ErrorsINVALID_ARGUMENT number is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT number is null
Compliancemandatory This method must be implemented.
MethodclearCustomerNumber
Description

Clears the customer number.

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

Gets the metadata for an activity.

Returnosid.Metadata metadata for the activity
Compliancemandatory This method must be implemented.
MethodsetActivity
Description

Sets the activity.

Parametersosid.id.IdactivityId the new activity
ErrorsINVALID_ARGUMENT activityId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT activityId is null
Compliancemandatory This method must be implemented.
MethodclearActivity
Description

Removes the activity.

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

Gets the CustomerFormRecord corresponding to the given customer record Type.

Parametersosid.type.TypecustomerRecordType a customer record type
Returnosid.billing.records.CustomerFormRecord the customer form record
ErrorsNULL_ARGUMENT customerRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(customerRecordType) is false
Compliancemandatory This method must be implemented.