OSID Logo
OSID Specifications
billing package
Version 3.0.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.Metadatametadata for the customer number
CompliancemandatoryThis method must be implemented.
MethodsetCustomerNumber
Description

Sets the customer number.

Parametersstringnumberthe new number
ErrorsINVALID_ARGUMENTnumber is invalid
NO_ACCESSMetadata.isReadOnly() is true
NULL_ARGUMENTnumber is null
CompliancemandatoryThis method must be implemented.
MethodclearCustomerNumber
Description

Clears the customer number.

ErrorsNO_ACCESSMetadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetActivityMetadata
Description

Gets the metadata for an activity.

Returnosid.Metadatametadata for the activity
CompliancemandatoryThis method must be implemented.
MethodsetActivity
Description

Sets the activity.

Parametersosid.id.IdactivityIdthe new activity
ErrorsINVALID_ARGUMENTactivityId is invalid
NO_ACCESSMetadata.isReadOnly() is true
NULL_ARGUMENTactivityId is null
CompliancemandatoryThis method must be implemented.
MethodclearActivity
Description

Removes the activity.

ErrorsNO_ACCESSMetadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetCustomerFormRecord
Description

Gets the CustomerFormRecord corresponding to the given customer record Type .

Parametersosid.type.TypecustomerRecordTypea customer record type
Returnosid.billing.records.CustomerFormRecordthe customer form record
ErrorsNULL_ARGUMENTcustomerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(customerRecordType) is false
CompliancemandatoryThis method must be implemented.