ibilling.client
Class Adjustment

java.lang.Object
  ibilling.client.ClientObject
      ibilling.client.Adjustment

All Implemented Interfaces:

java.io.Serializable

public class Adjustment
extends ClientObject

Represents a change made to a PaymentPlan. Adjustment captures the reason behind the changes.

The following changes are possible:

• Amount - changes billing amount of the plan
• PaymentOption - changes payment option used for electronic billing
• BillingCycle - changes date when invoices are generated
• Cancellation - cancels some or all charges within a plan
• Add - adds new billing charges to a plan
• Freeze - adds new freeze (skip-billing) charges to a plan

Since:

1.0

See Also:

Serialized Form

Field Summary

private java.lang.String	adjustmentReasonCode Predefined code explaining the reason for the changes.
private CustomerAccount	customerAccount Reference to CustomerAccount that owns the plans affected by the change.
private java.lang.String	notes Textual description of the adjustment reasons.
private static long	serialVersionUID The Constant serialVersionUID.

Constructor Summary

Adjustment()
Instantiates a new adjustment.

Adjustment(java.util.Date createDate, java.lang.Integer merchantAccountCode, java.lang.String code, java.lang.String notes, java.lang.String adjustmentReasonCode, CustomerAccount customerAccount, java.lang.Long id)
Instantiates a new adjustment.

Method Summary

java.lang.String	getAdjustmentReasonCode() Gets the adjustment reason code.
CustomerAccount	getCustomerAccount() Gets the customer account.
java.lang.String	getNotes() Gets the notes.
void	setAdjustmentReasonCode(java.lang.String adjustmentReasonCode) Set a value to adjustmentReasonCode.
(package private) void	setCustomerAccount(CustomerAccount customerAccount) Sets the customer account.
void	setNotes(java.lang.String notes) Set a value to notes.
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 ibilling.client.ClientObject

getClientProperty, getCode, getCreateDate, getId, getMerchantAccountCode, getRefId, hasClientProperty, setClientProperty, setCode, setCreateDate, setId, setMerchantAccountCode, setRefId

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The Constant serialVersionUID.

See Also:

Constant Field Values

notes

private java.lang.String notes

Textual description of the adjustment reasons.

adjustmentReasonCode

private java.lang.String adjustmentReasonCode

Predefined code explaining the reason for the changes.

customerAccount

private CustomerAccount customerAccount

Reference to CustomerAccount that owns the plans affected by the change.

Constructor Detail

Adjustment

Adjustment()

Instantiates a new adjustment.

Adjustment

Adjustment(java.util.Date createDate,
           java.lang.Integer merchantAccountCode,
           java.lang.String code,
           java.lang.String notes,
           java.lang.String adjustmentReasonCode,
           CustomerAccount customerAccount,
           java.lang.Long id)

Instantiates a new adjustment.

Parameters:

createDate - the create date

merchantAccountCode - the merchant account code

code - the code

notes - the notes

adjustmentReasonCode - the adjustment reason code

customerAccount - the customer account

id - the id

Method Detail

getNotes

public java.lang.String getNotes()

Gets the notes.

Returns:

Returns the notes

setNotes

public void setNotes(java.lang.String notes)

Set a value to notes.

Parameters:

notes - the notes

getAdjustmentReasonCode

public java.lang.String getAdjustmentReasonCode()

Gets the adjustment reason code.

Returns:

Returns the adjustmentReasonCode

setAdjustmentReasonCode

public void setAdjustmentReasonCode(java.lang.String adjustmentReasonCode)

Set a value to adjustmentReasonCode.

Parameters:

adjustmentReasonCode - the adjustment reason code

type

public java.lang.String type()

Description copied from class: ClientObject

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.

Specified by:

type in class ClientObject

Returns:

the type of the client object

getCustomerAccount

public CustomerAccount getCustomerAccount()

Gets the customer account.

Returns:

the customer account

setCustomerAccount

void setCustomerAccount(CustomerAccount customerAccount)

Sets the customer account.

Parameters:

customerAccount - the new customer account