ibilling.client
Class ClientObject

java.lang.Object
  ibilling.client.ClientObject

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AccountActivity, Adjustment, CaptureInfo, Charge, CustomerAccount, PaymentOption, PaymentPlan

public abstract class ClientObject
extends java.lang.Object
implements java.io.Serializable

Base class for all classes representing business entities within the library.

Since:

1.0

See Also:

Serialized Form

Field Summary

private java.util.Map<java.lang.String,java.lang.Object>	clientProperties Stores custom attributes associated with this object instance.
private java.lang.String	code User assigned identifier.
private java.util.Date	createDate Date the transaction was created.
private java.lang.Long	id System generated identifier.
private java.lang.Integer	merchantAccountCode Merchant account code.
private java.lang.Integer	refId

Constructor Summary

ClientObject()

Method Summary

java.lang.Object	getClientProperty(java.lang.String key) Gets the client property.
java.lang.String	getCode() Returns the code used to uniquely identify the object.
java.util.Date	getCreateDate() Gets the create date.
(package private) java.lang.Long	getId() Gets the id.
java.lang.Integer	getMerchantAccountCode() Returns the code identifying merchant to which the object belongs.
java.lang.Integer	getRefId()
boolean	hasClientProperty(java.lang.String name) Checks for client property.
void	setClientProperty(java.lang.String key, java.lang.Object value) Sets the client property.
void	setCode(java.lang.String code) Sets the code.
(package private) void	setCreateDate(java.util.Date createDate) Sets the create date.
(package private) void	setId(java.lang.Long id) Sets the id.
(package private) void	setMerchantAccountCode(java.lang.Integer merchantAccountCode) Set a value to merchantAccountCode.
void	setRefId(java.lang.Integer refId)
abstract java.lang.String	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

private java.lang.Long id

System generated identifier.

createDate

private java.util.Date createDate

Date the transaction was created.

code

private java.lang.String code

User assigned identifier. (if not specified, id is used)

merchantAccountCode

private java.lang.Integer merchantAccountCode

Merchant account code.

refId

private java.lang.Integer refId

clientProperties

private transient java.util.Map<java.lang.String,java.lang.Object> clientProperties

Stores custom attributes associated with this object instance.

Constructor Detail

ClientObject

public ClientObject()

Method Detail

getId

java.lang.Long getId()

Gets the id.

Returns:

the id

setId

void setId(java.lang.Long id)

Sets the id.

Parameters:

id - the new id

getCreateDate

public java.util.Date getCreateDate()

Gets the create date.

Returns:

Returns the createDate

setCreateDate

void setCreateDate(java.util.Date createDate)

Sets the create date.

Parameters:

createDate - the new create date

getCode

public java.lang.String getCode()

Returns the code used to uniquely identify the object.

Returns:

the code

setCode

public void setCode(java.lang.String code)

Sets the code.

Parameters:

code - the new code

getMerchantAccountCode

public java.lang.Integer getMerchantAccountCode()

Returns the code identifying merchant to which the object belongs.

Returns:

the merchant account code

setMerchantAccountCode

void setMerchantAccountCode(java.lang.Integer merchantAccountCode)

Set a value to merchantAccountCode.

Parameters:

merchantAccountCode - the merchant account code

setClientProperty

public void setClientProperty(java.lang.String key,
                              java.lang.Object value)

Sets the client property.

Parameters:

key - the key

value - the value

getClientProperty

public java.lang.Object getClientProperty(java.lang.String key)

Gets the client property.

Parameters:

key - the key

Returns:

the client property

hasClientProperty

public boolean hasClientProperty(java.lang.String name)

Checks for client property.

Parameters:

name - the name

Returns:

true, if successful

type

public abstract java.lang.String 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.

Returns:

the type of the client object

setRefId

public void setRefId(java.lang.Integer refId)

getRefId

public java.lang.Integer getRefId()