OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.Customer
Implementsosid.OsidObject
osid.Temporal
Description

A Customer represents data associated to a resource representing a customer. Contact information for this object can be managed in the Contact OSID.

MethodgetResourceId
Description

Gets the resource Id representing the customer.

Returnosid.id.Idthe resource Id
CompliancemandatoryThis method must be implemented.
MethodgetResource
Description

Gets the resource.

Returnosid.resource.Resourcethe resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetCustomerNumber
Description

Gets the customer account number.

Returnstringthe customer number
CompliancemandatoryThis method must be implemented.
MethodhasActivity
Description

Tests if this customer is linked to a financial activity,

Returnboolean true if this customer has an activity, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetActivityId
Description

Gets the activity Id.

Returnosid.id.Idthe activity Id
ErrorsILLEGAL_STATE hasActivity() is false
CompliancemandatoryThis method must be implemented.
MethodgetActivity
Description

Gets the activity.

Returnosid.financials.Activitythe activity
ErrorsILLEGAL_STATE hasActivity() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetCustomerRecord
Description

Gets the customer record corresponding to the given Customer record Type. This method is used to retrieve an object implementing the requested record. The customerRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(customerRecordType) is true .

Parametersosid.type.TypecustomerRecordTypethe type of customer record to retrieve
Returnosid.billing.records.CustomerRecordthe customer record
ErrorsNULL_ARGUMENT customerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(customerRecordType) is false
CompliancemandatoryThis method must be implemented.