Package com.storedobject.accounts

Class Invoice

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.accounts.Invoice

All Implemented Interfaces:

Displayable, StringFiller, Financial, HasId, OfEntity, TradeType

Direct Known Subclasses:

CustomerInvoice, SupplierInvoice

public abstract class Invoice
extends StoredObject
implements OfEntity, Financial, TradeType

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
Invoice()

Method Summary

Modifier and Type	Method	Description
void	addPayment(Money amount, Transaction transaction)
void	addPayment(Money amount, TransactionManager tm)
static String[]	browseColumns()
static void	columns(Columns columns)
Money	getAmount()
final AccountConfiguration	getConfiguration()
Date	getDate()
Rate	getExchangeRate()
boolean	getFromInventory()
abstract String	getInvoiceNo()
EntityAccount	getParty()
Id	getPartyId()
Money	getPayment()
String	getPaymentDetail()
int	getPaymentStatus()
String	getPaymentStatusValue()
static String	getPaymentStatusValue(int value)
static String[]	getPaymentStatusValues()
boolean	getPosted()
SystemEntity	getSystemEntity()
Id	getSystemEntityId()
Money	getTotal()
int	getType()	Retrieves the type of the invoice.
final boolean	isLedgerPosted()	Checks if the ledger is already posted.
protected String	particulars()
final void	postLedger(TransactionManager transactionManager)	Posts ledger transactions using the provided TransactionManager.
protected void	postTax(JournalVoucher journalVoucher)
static String[]	protectedColumns()
static void	readOnlyColumns(ColumnNames columnNames)
void	saved()	This method is invoked whenever an instance is saved/deleted/resurrected.
void	setAmount(Money amount)
void	setAmount(Object moneyValue)
void	setDate(Date date)
void	setExchangeRate(Rate exchangeRate)
void	setExchangeRate(Object value)
void	setFromInventory(boolean fromInventory)
void	setParty(EntityAccount party)
void	setParty(Id partyId)
void	setParty(BigDecimal idValue)
void	setPayment(Money payment)
void	setPayment(Money amount, Transaction transaction)
void	setPayment(Money amount, TransactionManager tm)
void	setPayment(Object moneyValue)
void	setPaymentDetail(String paymentDetail)
void	setPaymentStatus(int paymentStatus)
void	setPosted(boolean posted)
void	setSystemEntity(Id systemEntityId)
void	setSystemEntity(SystemEntity systemEntity)
void	setSystemEntity(BigDecimal idValue)
void	setTotal(Money total)
void	setTotal(Object moneyValue)
void	setType(int type)
void	validateData(TransactionManager tm)	The system will invoke this whenever the object is saved to the DB.
void	validateDelete()	This method will be invoked whenever an existing instance is deleted from the database.
void	validateUpdate()	This method will be invoked whenever an existing instance is updated in the database.

Methods inherited from class com.storedobject.core.StoredObject

addLink, addLink, addLink, addLink, addLink, addLink, addLink, addLink, checkCurrency, checkCurrency, checkForDuplicate, checkForDuplicate, checkTimeZone, checkTransaction, clearObjectLinks, contemporary, copy, copy, count, count, count, count, count, count, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, create, created, delete, delete, delete, deleted, directUpdate, equals, exists, exists, exists, exists, exists, existsFileData, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsMaster, existsMaster, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, family, family, family, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getActor, getAttachment, getAttachmentId, getChildren, getContemporaryOf, getDeleted, getDeleted, getExistsCondition, getExistsCondition, getFileData, getFileData, getHistorical, getId, getKeyIndex, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getNotExistsCondition, getNotExistsCondition, getParent, getParent, getParent, getParentId, getParentId, getParentId, getRelated, getRelated, getTransaction, getTransactionId, getTransactionIP, getUnique, getUniqueCondition, hashCode, inserted, isModified, isVirtual, list, list, list, list, list, list, list, list, list, list, list, list, list, listDeletedIds, listFileData, listFileData, listHistory, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listTree, listTree, listTree, listTree, listViaQuery, listViaQuery, load, load, load, load, loadAttributesFrom, loaded, loading, makeNew, makeVirtual, migrate, moduleName, nextVersion, objectLink, objectLink, objectLink, objectLinks, objectLinks, old, person, previousVersion, previousVersion, query, query, query, query, query, query, query, query, query, query, query, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, reload, reload, reloaded, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeReverseLinks, removeReverseLinks, save, save, save, save, save, save, save, save, save, save, save, save, save, save, save, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, toString, transacting, undelete, undelete, undeleted, updated, user, userId, validate, validateChildAttach, validateChildDetach, validateChildUpdate, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, valueEquals

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.storedobject.core.OfEntity

check, findSystemEntityId

Constructor Details

Invoice

public Invoice()

Method Details

columns

public static void columns(Columns columns)

protectedColumns

public static String[] protectedColumns()

browseColumns

public static String[] browseColumns()

readOnlyColumns

public static void readOnlyColumns(ColumnNames columnNames)

setSystemEntity

public void setSystemEntity(Id systemEntityId)

Specified by:

setSystemEntity in interface OfEntity

setSystemEntity

public void setSystemEntity(BigDecimal idValue)

setSystemEntity

public void setSystemEntity(SystemEntity systemEntity)

getSystemEntityId

@SetNotAllowed
@Column(order=100)
public Id getSystemEntityId()

Specified by:

getSystemEntityId in interface OfEntity

getSystemEntity

public SystemEntity getSystemEntity()

Specified by:

getSystemEntity in interface OfEntity

setType

public void setType(int type)

getType

@SetNotAllowed
@Column(order=150)
public int getType()

Retrieves the type of the invoice.

Note: The type should match with the PO type for proper linkage.

Specified by:

getType in interface TradeType

Returns:

The type of the invoice as an integer.

setDate

public void setDate(Date date)

getDate

@Column(order=200)
public Date getDate()

setParty

public void setParty(Id partyId)

setParty

public void setParty(BigDecimal idValue)

setParty

public void setParty(EntityAccount party)

getPartyId

@Column(style="(any)",
        order=350,
        caption="Party Account")
public Id getPartyId()

getParty

public EntityAccount getParty()

setAmount

public void setAmount(Money amount)

setAmount

public void setAmount(Object moneyValue)

getAmount

@Column(order=400)
public Money getAmount()

setTotal

public void setTotal(Money total)

setTotal

public void setTotal(Object moneyValue)

getTotal

@Column(order=500)
public Money getTotal()

setPosted

public void setPosted(boolean posted)

getPosted

@SetNotAllowed
@Column(order=600)
public boolean getPosted()

setPayment

public void setPayment(Money payment)

setPayment

public void setPayment(Object moneyValue)

getPayment

@SetNotAllowed
@Column(required=false,
        order=700)
public Money getPayment()

setPaymentDetail

public void setPaymentDetail(String paymentDetail)

getPaymentDetail

@Column(required=false,
        order=800)
public String getPaymentDetail()

setPaymentStatus

public void setPaymentStatus(int paymentStatus)

getPaymentStatus

@SetNotAllowed
@Column(order=900)
public int getPaymentStatus()

getPaymentStatusValues

public static String[] getPaymentStatusValues()

getPaymentStatusValue

public static String getPaymentStatusValue(int value)

getPaymentStatusValue

public String getPaymentStatusValue()

setFromInventory

public void setFromInventory(boolean fromInventory)

getFromInventory

@SetNotAllowed
@Column(order=1000)
public boolean getFromInventory()

setExchangeRate

public void setExchangeRate(Rate exchangeRate)

setExchangeRate

public void setExchangeRate(Object value)

getExchangeRate

@Column(style="(d:14,6)",
        order=1100)
public Rate getExchangeRate()

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Description copied from class: StoredObject

The system will invoke this whenever the object is saved to the DB. It will be invoked in all cases while creating new objects and updating/deleting/undeleting existing objects. If any exception is raised by this method, the process of saving to the DB will be abandoned.

Note: This method is mainly used to validate the data of all attributes of the object, and it may be used by others for validating the object. For example, front-end data-entry systems can use this method for validating the object.

Overrides:

validateData in class StoredObject

Parameters:

tm - Current transaction manager.

Throws:

Exception - If data is invalid.

saved

public void saved()
           throws Exception

Description copied from class: StoredObject

This method is invoked whenever an instance is saved/deleted/resurrected. It can be overridden to take care of any additional actions required by the application.

Overrides:

saved in class StoredObject

Throws:

Exception - When error occurs or invalidate state exists so that transaction will be abandoned.

validateUpdate

public void validateUpdate()
                    throws Exception

Description copied from class: StoredObject

This method will be invoked whenever an existing instance is updated in the database. So, it will be called within an active transaction. Child classes can override this method to do validation when an existing instance is updated in the database.

Note: When overridden "super" should be called, otherwise, a "design error" will occur.

Also, see StoredObject.validate().

Overrides:

validateUpdate in class StoredObject

Throws:

Exception - By raising an exception from this method, the current transaction can be abandoned.

validateDelete

public void validateDelete()
                    throws Exception

Description copied from class: StoredObject

This method will be invoked whenever an existing instance is deleted from the database. So, it will be called within an active transaction. Child classes can override this method to do validation when an existing instance is deleted from the database.

Note: When overridden "super" should be called, otherwise, a "design error" will occur.

Also, see StoredObject.validate().

Overrides:

validateDelete in class StoredObject

Throws:

Exception - By raising an exception from this method, the current transaction can be abandoned.

getConfiguration

public final AccountConfiguration getConfiguration()

isLedgerPosted

public final boolean isLedgerPosted()

Description copied from interface: Financial

Checks if the ledger is already posted.

Specified by:

isLedgerPosted in interface Financial

Returns:

true if the ledger is already posted, false otherwise.

postLedger

public final void postLedger(TransactionManager transactionManager)
                      throws Exception

Description copied from interface: Financial

Posts ledger transactions using the provided TransactionManager.

Specified by:

postLedger in interface Financial

Parameters:

transactionManager - the TransactionManager used to post the ledger transaction

Throws:

Exception - if the ledger is already posted

postTax

protected void postTax(JournalVoucher journalVoucher)
                throws Exception

Throws:

Exception

particulars

protected String particulars()

addPayment

public void addPayment(Money amount,
 TransactionManager tm)
                throws Exception

Throws:

Exception

addPayment

public void addPayment(Money amount,
 Transaction transaction)
                throws Exception

Throws:

Exception

setPayment

public void setPayment(Money amount,
 TransactionManager tm)
                throws Exception

Throws:

Exception

setPayment

public void setPayment(Money amount,
 Transaction transaction)
                throws Exception

Throws:

Exception

getInvoiceNo

public abstract String getInvoiceNo()