Docs For Class Adjustment

Description

ClientObject
   |
   --Adjustment

Variable Summary

String $adjustmentReasonCode

CustomerAccount $customerAccount

String $notes

Method Summary

Adjustment __construct ([DateTime $createDate = null], [int $merchantAccountCode = null], [String $code = null], [String $notes = null], [String $adjustmentReasonCode = null], [CustomerAccount $customerAccount = null], [int $id = null])

String getAdjustmentReasonCode ()

CustomerAccount getCustomerAccount ()

String getNotes ()

void setAdjustmentReasonCode (String $adjustmentReasonCode)

void setCustomerAccount (CustomerAccount $customerAccount)

void setNotes (String $notes)

void type ()

Variables

String $adjustmentReasonCode (line 28)

var: Predefined code explaining the reason for the changes.
access: private

CustomerAccount $customerAccount (line 32)

var: Reference to CustomerAccount that owns the plans affected by the change.
access: private

String $notes (line 24)

var: Textual description of the adjustment reasons.
access: private

Inherited Variables

Inherited from ClientObject

ClientObject::$code
ClientObject::$createDate
ClientObject::$id
ClientObject::$merchantAccountCode
ClientObject::$_hashCode

Methods

Constructor __construct (line 44)

Instantiates a new adjustment.

Adjustment __construct ([DateTime $createDate = null], [int $merchantAccountCode = null], [String $code = null], [String $notes = null], [String $adjustmentReasonCode = null], [CustomerAccount $customerAccount = null], [int $id = null])

DateTime $createDate: createDate the create date
int $merchantAccountCode: merchantAccountCode the merchant account code
String $code: code the code
String $notes: notes the notes
String $adjustmentReasonCode: adjustmentReasonCode the adjustment reason code
CustomerAccount $customerAccount: customerAccount the customer account
int $id: id the id

getAdjustmentReasonCode (line 77)

Gets the adjustment reason code.

return: Returns the adjustmentReasonCode
access: public

String getAdjustmentReasonCode ()

getCustomerAccount (line 99)

Gets the customer account.

return: the customer account
access: public

CustomerAccount getCustomerAccount ()

getNotes (line 59)

Gets the notes.

return: Returns the notes
access: public

String getNotes ()

setAdjustmentReasonCode (line 86)

Set a value to adjustmentReasonCode.

access: public

void setAdjustmentReasonCode (String $adjustmentReasonCode)

String $adjustmentReasonCode: adjustmentReasonCode the adjustment reason code

setCustomerAccount (line 108)

Sets the customer account.

void setCustomerAccount (CustomerAccount $customerAccount)

CustomerAccount $customerAccount: customerAccount the new customer account

setNotes (line 68)

Set a value to notes.

access: public

void setNotes (String $notes)

String $notes: notes the notes

type (line 90)

access: public

void type ()

Redefinition of:

ClientObject::type(): Returns the type of the object instance using library's terminology In most cases it will match ClassName, but when a single class may represent multiple conceptual objects, the value will differ.

Inherited Methods

Inherited From ClientObject

ClientObject::getCode()
ClientObject::getCreateDate()
ClientObject::getId()
ClientObject::getMerchantAccountCode()
ClientObject::hashCode()
ClientObject::setCode()
ClientObject::setId()
ClientObject::setMerchantAccountCode()
ClientObject::type()