OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.CustomerForm
Implementsosid.OsidObjectForm
osid.OsidTemporalForm
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_ARGUMENT number is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT number is null
CompliancemandatoryThis method must be implemented.
MethodclearCustomerNumber
Description

Clears the customer number.

ErrorsNO_ACCESS Metadata.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_ARGUMENT activityId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT activityId is null
CompliancemandatoryThis method must be implemented.
MethodclearActivity
Description

Removes the activity.

ErrorsNO_ACCESS Metadata.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_ARGUMENT customerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(customerRecordType) is false
CompliancemandatoryThis method must be implemented.