UtlInvBase (Beigesoft™ Accounting library. 1.1.8 API)

java.lang.Object
- org.beigesoft.accounting.processor.UtlInvBase<RS>

Type Parameters:

RS - platform dependent record set type
```
public class UtlInvBase<RS>
extends Object
```
Utility for purchase/sales invoice. Base shared code-bunch.

Author:

Yury Demidenko

Constructor Summary

Constructors
Constructor and Description

UtlInvBase()

Constructors
Constructor and Description
`UtlInvBase()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addInvBsTxExTxc(List<SalesInvoiceServiceLine> pTxdLns, Long pCatId, Double pSubt, Double pSubtFc, Double pPercent, AccSettings pAs, TaxDestination pTxRules)` Adds total tax by category for farther invoice adjusting.
`<T extends IInvoice,L extends IInvoiceLine<T>,TL extends AInvTxLn<T>> void`	`adjustInvoiceLns(Map<String,Object> pReqVars, T pInv, List<SalesInvoiceServiceLine> pTxdLns, AccSettings pAs, IInvTxMeth<T,TL> pInvTxMeth)` Adjust invoice lines totals/subtotals/cost for invoice basis method.
`<T extends IInvoice,TL extends AInvTxLn<T>> TL`	`findCreateTaxLine(Map<String,Object> pReqVars, T pInv, List<TL> pInvTxLns, Tax pTax, boolean pNeedFind, org.beigesoft.factory.IFactorySimple<TL> pFctInvTxLn)` Finds (if need) line with same tax or creates one.
`org.beigesoft.log.ILogger`	`getLogger()` Geter for logger.
`org.beigesoft.service.ISrvDatabase<RS>`	`getSrvDatabase()` Getter for srvDatabase.
`org.beigesoft.service.ISrvNumberToString`	`getSrvNumberToString()` Getter for srvNumberToString.
`org.beigesoft.service.ISrvOrm<RS>`	`getSrvOrm()` Geter for srvOrm.
`<T extends IInvoice,L extends IInvoiceLine<T>,TL extends AInvTxLn<T>,LTL extends ALineTxLn<T,L>> void`	`makeLine(Map<String,Object> pReqVars, L pLine, AccSettings pAs, TaxDestination pTxRules, IInvTxMeth<T,TL> pInvTxMeth, IInvLnTxMeth<T,L,LTL> pInvLnTxMeth)` Makes invoice line's taxes, totals.
`<T extends IInvoice,L extends IInvoiceLine<T>,TL extends AInvTxLn<T>> void`	`makeTotals(Map<String,Object> pReqVars, L pLine, AccSettings pAs, TaxDestination pTxRules, IInvTxMeth<T,TL> pInvTxMeth)` Makes invoice totals include taxes lines cause line inserted/changed/deleted.
`SalesInvoiceServiceLine`	`makeTxdLine(List<SalesInvoiceServiceLine> pTxdLns, Long pTdlId, Long pCatId, Tax pTax, Double pPercent, AccSettings pAs)` Make invoice line that stores taxes data in lines set for invoice basis or item basis aggregate rate.
`<T extends IInvoice,L extends IInvoiceLine<T>> void`	`mkLnFinal(L pLine, BigDecimal pTotTxs, BigDecimal pTotTxsFc, Boolean pIsTxByUser)` Makes invoice line final results.
`<T extends IInvoice,L extends IInvoiceLine<T>,LTL extends ALineTxLn<T,L>> List<LTL>`	`mkLnTxItBasNonAggr(Map<String,Object> pReqVars, L pLine, AccSettings pAs, TaxDestination pTxRules, IInvTxMeth<T,?> pInvTxMeth, IInvLnTxMeth<T,L,LTL> pInvLnTxMeth)` Makes invoice line taxes item basis basis non-aggregate.
`String`	`prn(Map<String,Object> pReqVars, BigDecimal pVal)` Simple delegator to print number.
`<T extends IInvoice,L extends IInvoiceLine<T>,TL extends AInvTxLn<T>> DataTx`	`retrieveDataTx(Map<String,Object> pReqVars, L pLine, AccSettings pAs, TaxDestination pTxRules, IInvTxMeth<T,TL> pInvTxMeth)` Retrieve from database bundle of tax data.
`<T extends IInvoice,L extends IInvoiceLine<T>,TL extends AInvTxLn<T>> ArrayList<SalesInvoiceServiceLine>`	`retrTxdLnsAdjInv(Map<String,Object> pReqVars, T pInv, AccSettings pAs, TaxDestination pTxRules, IInvTxMeth<T,TL> pInvTxMeth)` Retrieve from database tax data for adjusting invoice lines after invoice tax line has been changed by user.
`TaxDestination`	`revealTaxRules(Map<String,Object> pReqVars, IInvoice pInv, AccSettings pAs, Boolean pIsExtrTx)` Reveal shared tax rules for invoice..
`void`	`setLogger(org.beigesoft.log.ILogger pLogger)` Setter for logger.
`void`	`setSrvDatabase(org.beigesoft.service.ISrvDatabase<RS> pSrvDatabase)` Setter for srvDatabase.
`void`	`setSrvNumberToString(org.beigesoft.service.ISrvNumberToString pSrvNumberToString)` Setter for srvNumberToString.
`void`	`setSrvOrm(org.beigesoft.service.ISrvOrm<RS> pSrvOrm)` Setter for srvOrm.
`<T extends IInvoice> void`	`updInvTots(Map<String,Object> pReqVars, T pInv, AccSettings pAs, IInvTxMeth<T,?> pInvTxMeth)` Update invoice totals after its line has been changed/deleted and taxes lines has been made or after tax line has been changed (Invoice basis).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- UtlInvBase
```
public UtlInvBase()
```

Method Detail

revealTaxRules

public final TaxDestination revealTaxRules(Map<String,Object> pReqVars,
                                           IInvoice pInv,
                                           AccSettings pAs,
                                           Boolean pIsExtrTx)
                                    throws Exception

Reveal shared tax rules for invoice..

Parameters:: pReqVars - request scoped vars; pInv - invoice; pAs - Accounting Settings; pIsExtrTx - if extract taxes
Returns:: tax rules, NULL if not taxable
Throws:: Exception - - an exception.

makeTotals

public final <T extends IInvoice,L extends IInvoiceLine<T>,TL extends AInvTxLn<T>> void makeTotals(Map<String,Object> pReqVars,
                                                                                                   L pLine,
                                                                                                   AccSettings pAs,
                                                                                                   TaxDestination pTxRules,
                                                                                                   IInvTxMeth<T,TL> pInvTxMeth)
                                                                                            throws Exception

Makes invoice totals include taxes lines cause line inserted/changed/deleted.

Type Parameters:: T - invoice type; L - invoice line type; TL - invoice tax line type
Parameters:: pReqVars - request scoped vars; pLine - affected line; pAs - Accounting Settings; pTxRules - NULL if not taxable; pInvTxMeth - tax method code/data for purchase/sales invoice
Throws:: Exception - - an exception.

updInvTots

public final <T extends IInvoice> void updInvTots(Map<String,Object> pReqVars,
                                                  T pInv,
                                                  AccSettings pAs,
                                                  IInvTxMeth<T,?> pInvTxMeth)
                                           throws Exception

Update invoice totals after its line has been changed/deleted and taxes lines has been made or after tax line has been changed (Invoice basis).

Type Parameters:: T - invoice type
Parameters:: pReqVars - additional param; pInv - Invoice; pAs - accounting settings; pInvTxMeth - tax method code/data for purchase/sales invoice
Throws:: Exception - - an exception

adjustInvoiceLns

public final <T extends IInvoice,L extends IInvoiceLine<T>,TL extends AInvTxLn<T>> void adjustInvoiceLns(Map<String,Object> pReqVars,
                                                                                                         T pInv,
                                                                                                         List<SalesInvoiceServiceLine> pTxdLns,
                                                                                                         AccSettings pAs,
                                                                                                         IInvTxMeth<T,TL> pInvTxMeth)
                                                                                                  throws Exception

Adjust invoice lines totals/subtotals/cost for invoice basis method.

Type Parameters:: T - invoice type; L - invoice line type; TL - invoice tax line type
Parameters:: pReqVars - additional param; pInv - invoice; pTxdLns - Tax Data lines; pAs - AS; pInvTxMeth - tax method code/data for purchase/sales invoice
Throws:: Exception - an Exception

retrTxdLnsAdjInv

public final <T extends IInvoice,L extends IInvoiceLine<T>,TL extends AInvTxLn<T>> ArrayList<SalesInvoiceServiceLine> retrTxdLnsAdjInv(Map<String,Object> pReqVars,
                                                                                                                                       T pInv,
                                                                                                                                       AccSettings pAs,
                                                                                                                                       TaxDestination pTxRules,
                                                                                                                                       IInvTxMeth<T,TL> pInvTxMeth)
                                                                                                                                throws Exception

Retrieve from database tax data for adjusting invoice lines after invoice tax line has been changed by user.

Type Parameters:: T - invoice type; L - invoice line type; TL - invoice tax line type
Parameters:: pReqVars - request scoped vars; pInv - affected invoice; pAs - Accounting Settings; pTxRules - taxable rules; pInvTxMeth - tax method code/data for purchase/sales invoice
Returns:: taxes data
Throws:: Exception - - an exception.

makeLine

public final <T extends IInvoice,L extends IInvoiceLine<T>,TL extends AInvTxLn<T>,LTL extends ALineTxLn<T,L>> void makeLine(Map<String,Object> pReqVars,
                                                                                                                            L pLine,
                                                                                                                            AccSettings pAs,
                                                                                                                            TaxDestination pTxRules,
                                                                                                                            IInvTxMeth<T,TL> pInvTxMeth,
                                                                                                                            IInvLnTxMeth<T,L,LTL> pInvLnTxMeth)
                                                                                                                     throws Exception

Makes invoice line's taxes, totals.

Type Parameters:: T - invoice type; L - invoice line type; TL - invoice tax line type; LTL - invoice line's tax line type
Parameters:: pReqVars - request scoped vars; pLine - invoice line; pAs - Accounting Settings; pTxRules - NULL if not taxable; pInvTxMeth - tax method code/data for purchase/sales invoice; pInvLnTxMeth - tax method code/data for purchase/sales invoice line
Throws:: Exception - - an exception.

retrieveDataTx

public final <T extends IInvoice,L extends IInvoiceLine<T>,TL extends AInvTxLn<T>> DataTx retrieveDataTx(Map<String,Object> pReqVars,
                                                                                                         L pLine,
                                                                                                         AccSettings pAs,
                                                                                                         TaxDestination pTxRules,
                                                                                                         IInvTxMeth<T,TL> pInvTxMeth)
                                                                                                  throws Exception

Retrieve from database bundle of tax data.

Type Parameters:: T - invoice type; L - invoice line type; TL - invoice tax line type
Parameters:: pReqVars - request scoped vars; pLine - affected line; pAs - Accounting Settings; pTxRules - taxable rules; pInvTxMeth - tax method code/data for purchase/sales invoice
Returns:: taxes data
Throws:: Exception - - an exception.

addInvBsTxExTxc

public final void addInvBsTxExTxc(List<SalesInvoiceServiceLine> pTxdLns,
                                  Long pCatId,
                                  Double pSubt,
                                  Double pSubtFc,
                                  Double pPercent,
                                  AccSettings pAs,
                                  TaxDestination pTxRules)

Adds total tax by category for farther invoice adjusting.

Parameters:: pTxdLns - Tax Data lines; pCatId - tax category ID; pSubt - subtotal without taxes; pSubtFc - subtotal FC without taxes; pPercent - tax rate; pAs - AS; pTxRules - tax rules

makeTxdLine

public final SalesInvoiceServiceLine makeTxdLine(List<SalesInvoiceServiceLine> pTxdLns,
                                                 Long pTdlId,
                                                 Long pCatId,
                                                 Tax pTax,
                                                 Double pPercent,
                                                 AccSettings pAs)

Make invoice line that stores taxes data in lines set for invoice basis or item basis aggregate rate.

Parameters:: pTxdLns - Tax Data lines; pTdlId - line ID; pCatId - tax category ID; pTax - tax; pPercent - tax rate; pAs - AS
Returns:: line

mkLnTxItBasNonAggr

public final <T extends IInvoice,L extends IInvoiceLine<T>,LTL extends ALineTxLn<T,L>> List<LTL> mkLnTxItBasNonAggr(Map<String,Object> pReqVars,
                                                                                                                    L pLine,
                                                                                                                    AccSettings pAs,
                                                                                                                    TaxDestination pTxRules,
                                                                                                                    IInvTxMeth<T,?> pInvTxMeth,
                                                                                                                    IInvLnTxMeth<T,L,LTL> pInvLnTxMeth)
                                                                                                             throws Exception

Makes invoice line taxes item basis basis non-aggregate.

Type Parameters:: T - invoice type; L - invoice line type; LTL - invoice line's tax line type
Parameters:: pReqVars - request scoped vars; pLine - invoice line; pAs - Accounting Settings; pTxRules - taxable rules; pInvTxMeth - tax method code/data for purchase/sales invoice; pInvLnTxMeth - tax method code/data for purchase/sales invoice line
Returns:: created invoice line taxes for farther proceed
Throws:: Exception - - an exception.

mkLnFinal

public final <T extends IInvoice,L extends IInvoiceLine<T>> void mkLnFinal(L pLine,
                                                                           BigDecimal pTotTxs,
                                                                           BigDecimal pTotTxsFc,
                                                                           Boolean pIsTxByUser)

Makes invoice line final results.

Type Parameters:: T - invoice type; L - invoice line type
Parameters:: pLine - invoice line; pTotTxs - total line taxes; pTotTxsFc - total line taxes FC; pIsTxByUser - if tax set by user

findCreateTaxLine

public final <T extends IInvoice,TL extends AInvTxLn<T>> TL findCreateTaxLine(Map<String,Object> pReqVars,
                                                                              T pInv,
                                                                              List<TL> pInvTxLns,
                                                                              Tax pTax,
                                                                              boolean pNeedFind,
                                                                              org.beigesoft.factory.IFactorySimple<TL> pFctInvTxLn)
                                                                       throws Exception

Finds (if need) line with same tax or creates one.

Type Parameters:: T - invoice type; TL - invoice tax line type
Parameters:: pReqVars - additional param; pInv - invoice; pInvTxLns - invoice tax lines; pTax - tax; pNeedFind - if need to find enabled; pFctInvTxLn - invoice tax line factory
Returns:: line
Throws:: Exception - if no need to find but line is found

prn

public final String prn(Map<String,Object> pReqVars,
                        BigDecimal pVal)

Simple delegator to print number.

Parameters:: pReqVars - additional param; pVal - value
Returns:: String

getSrvNumberToString

public final org.beigesoft.service.ISrvNumberToString getSrvNumberToString()

Getter for srvNumberToString.

Returns:: ISrvNumberToString

setSrvNumberToString

public final void setSrvNumberToString(org.beigesoft.service.ISrvNumberToString pSrvNumberToString)

Setter for srvNumberToString.

Parameters:: pSrvNumberToString - reference

getSrvDatabase

public final org.beigesoft.service.ISrvDatabase<RS> getSrvDatabase()

Getter for srvDatabase.

Returns:: ISrvDatabase

setSrvDatabase

public final void setSrvDatabase(org.beigesoft.service.ISrvDatabase<RS> pSrvDatabase)

Setter for srvDatabase.

Parameters:: pSrvDatabase - reference

getSrvOrm

public final org.beigesoft.service.ISrvOrm<RS> getSrvOrm()

Geter for srvOrm.

Returns:: ISrvOrm

setSrvOrm

public final void setSrvOrm(org.beigesoft.service.ISrvOrm<RS> pSrvOrm)

Setter for srvOrm.

Parameters:: pSrvOrm - reference

getLogger

public final org.beigesoft.log.ILogger getLogger()

Geter for logger.

Returns:: ILogger

setLogger

public final void setLogger(org.beigesoft.log.ILogger pLogger)

Setter for logger.

Parameters:: pLogger - reference

Class UtlInvBase<RS>

Constructor Summary