Docs For Class ClientObject

Description

abstract:

Direct descendents

Class	Description
AccountActivity
Adjustment
CaptureInfo
Charge
CustomerAccount
PaymentOption
PaymentPlan

Variable Summary

String $code

DateTime $createDate

int $id

int $merchantAccountCode

mixed $_hashCode

Method Summary

String getCode ()

DateTime getCreateDate ()

int getId ()

int getMerchantAccountCode ()

void hashCode ()

void setCode (String $code)

void setId (int $id)

void setMerchantAccountCode (int $merchantAccountCode)

String type ()

Variables

String $code (line 20)

var: User assigned identifier. (if not specified, id is used)
access: protected

DateTime $createDate (line 16)

var: Date the transaction was created.
access: protected

int $id (line 12)

var: System generated identifier.
access: protected

int $merchantAccountCode (line 24)

var: Merchant account code.
access: protected

mixed $_hashCode (line 28)

Used to uniquely identify objects that don't have id defined.

Used to uniquely identify objects that don't have id defined. Not really a hashCode.

access: private

Methods

getCode (line 61)

Returns the code used to uniquely identify the object.

return: the code
access: public

String getCode ()

getCreateDate (line 52)

Gets the create date.

return: Returns the createDate
access: public

DateTime getCreateDate ()

getId (line 34)

Gets the id.

return: the id

int getId ()

getMerchantAccountCode (line 79)

Returns the code identifying merchant to which the object belongs.

return: the merchant account code
access: public

int getMerchantAccountCode ()

hashCode (line 103)

access: public

void hashCode ()

setCode (line 70)

Sets the code.

access: public

void setCode (String $code)

String $code: code the new code

setId (line 43)

Sets the id.

void setId (int $id)

int $id: id the new id

setMerchantAccountCode (line 88)

Set a value to merchantAccountCode.

void setMerchantAccountCode (int $merchantAccountCode)

int $merchantAccountCode: merchantAccountCode the merchant account code

Redefined in descendants as:

CustomerAccount::setMerchantAccountCode()

type (line 99)

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.

return: the type of the client object
access: public

String type ()

Redefined in descendants as: