OSID Logo
OSID Specifications
billing package
Version 3.1.0
Interfaceosid.billing.Customer
Implementsosid.OsidObject
osid.Temporal
Used Byosid.billing.CustomerAdminSession
osid.billing.CustomerList
osid.billing.CustomerLookupSession
osid.billing.Entry
osid.billing.payment.Payer
osid.billing.payment.Payment
osid.billing.payment.Summary
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.Id the resource Id
Compliancemandatory This method must be implemented.
MethodgetResource
Description

Gets the resource.

Returnosid.resource.Resource the resource
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetCustomerNumber
Description

Gets the customer account number.

Returnstring the customer number
Compliancemandatory This 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
Compliancemandatory This method must be implemented.
MethodgetActivityId
Description

Gets the activity Id.

Returnosid.id.Id the activity Id
ErrorsILLEGAL_STATE hasActivity() is false
Compliancemandatory This method must be implemented.
MethodgetActivity
Description

Gets the activity.

Returnosid.financials.Activity the activity
ErrorsILLEGAL_STATE hasActivity() is false
OPERATION_FAILED unable to complete request
Compliancemandatory This 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.TypecustomerRecordType the type of customer record to retrieve
Returnosid.billing.records.CustomerRecord the customer record
ErrorsNULL_ARGUMENT customerRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(customerRecordType) is false
Compliancemandatory This method must be implemented.