Inheritance diagram for org.turro.financials.entity.Document:

[legend]

Collaboration diagram for org.turro.financials.entity.Document:

[legend]

Public Member Functions
Set< DocumentRelation >	getAncestors ()

void	setAncestors (Set< DocumentRelation > ancestors)

Contract	getContract ()

void	setContract (Contract contract)

Currency	getCurrency ()

void	setCurrency (Currency currency)

Set< DocumentRelation >	getDescendants ()

Set< DocumentRelation >	getUpdatedDescendants ()

void	setDescendants (Set< DocumentRelation > descendants)

Date	getDocumentDate ()

void	setDocumentDate (Date documentDate)

DocumentDefinition	getDocumentDefinition ()

void	setDocumentDefinition (DocumentDefinition documentDefinition)

Set< DocumentLine >	getDocumentLines ()

void	setDocumentLines (Set< DocumentLine > documentLines)

String	getDocumentNumber ()

void	setDocumentNumber (String documentNumber)

boolean	isDraft ()

void	setDraft (boolean draft)

RegisterView	getForcedView ()

void	setForcedView (RegisterView forcedView)

long	getId ()

void	setId (long id)

boolean	isNoAncestors ()

void	setNoAncestors (boolean noAncestors)

boolean	isNoDescendants ()

void	setNoDescendants (boolean noDescendants)

String	getNotes ()

void	setNotes (String notes)

double	getQuote ()

void	setQuote (double quote)

Date	getReceiptDate ()

void	setReceiptDate (Date receiptDate)

Set< Register >	getRegisters ()

void	setRegisters (Set< Register > registers)

String	getRelatedPath ()

void	setRelatedPath (String relatedPath)

Object	entityId ()

boolean	isEmpty ()

void	prepareSave ()

Collection< Collection >	collections ()

IElephantEntity	getRelated ()

boolean	isValid ()

boolean	isBlank ()

String	getConcept ()

String	getCleanFullNotes ()

String	getFullNotes ()

void	clearEmpties ()

void	assignTableOrder (Collection< DocumentLine > lines)

DocumentAmounts	getAmounts ()

DocumentAmountsByBook	getAmountsByBook (BookDefinition bookDefinition)

double	getSubTotal ()

double	getTotalAmount ()

ContractPreference	getDefaultContractPreference ()

void	appendLines (Document relDoc, String header, DocumentWorkflow workflow)

void	appendAmounts (Document relDoc, String header, DocumentWorkflow workflow)

void	flowFrom (Document doc, String header, DocumentWorkflow workflow)

void	backFrom (Document doc, String header, DocumentWorkflow workflow)

void	copyFrom (Document doc, boolean shallowCopy)

Collection< ContractFlow >	getContractFlows ()

Collection< DocumentWorkflow >	getWorkflows ()

Collection< DocumentWorkflow >	getWorkflows (boolean forward, boolean missing)

Collection< Contact >	getActualHqContacts ()

String	getDocDescription ()

String	getDocumentString ()

Collection< Contract >	getStores ()

Contract	getDefaultStore ()

int	getMaxLineOrder ()

String	getUsualPath ()

LineType	getDefaultLineType ()

Collection< LineType >	getLineTypes ()

Object	doAction (Date now, String data)

long	getBookNumber ()

boolean	isConciliateRegister ()

void	setConciliateRegister (boolean conciliateRegister)

boolean	isRegularizeVAT ()

void	setRegularizeVAT (boolean regularizeVAT)

boolean	isRegularizeIRPF ()

void	setRegularizeIRPF (boolean regularizeIRPF)

MappingSet	getSerializerMappings ()

Public Member Functions inherited from org.turro.jpa.entity.IDaoEntity
default boolean	isNew ()

default void	prepareDelete ()

default void	removeEmpties ()

Public Attributes
transient boolean	conciliateRegister

transient boolean	regularizeVAT

transient boolean	regularizeIRPF

Detailed Description

Author: Lluis Turró Cutiller lluis.nosp@m.@tur.nosp@m.ro.or.nosp@m.g

Definition at line 56 of file Document.java.

Member Function Documentation

◆ appendAmounts()

void org.turro.financials.entity.Document.appendAmounts	(	Document	relDoc,
		String	header,
		DocumentWorkflow	workflow
	)

Definition at line 493 of file Document.java.

                                                                                        {
     int count = getMaxLineOrder() + 1;
     LineType lt = workflow == null ? null : workflow.getLineType();
     if(lt == null) {
       for(RelatedLineType rlt : getDocumentDefinition().getRelatedLineTypes()) {
         if(rlt.getLineType().getStockCoefficient() == 0) {
           lt = rlt.getLineType();
           break;
         }
       }
     }
     if(lt == null) {
       lt = getDefaultLineType();
     }
     Contract defaultStore = getDefaultStore();
     if(getDocumentDefinition().hasColumn(DocumentColumn.DCOL_TAX)) {
       for(AmountTaxable l : relDoc.getAmounts().getTaxables()) {
         DocumentLine dl = new DocumentLine();
         dl.setDocument(this);
         if(header != null) {
           dl.setConcept(header + " [" + l.getTax() + "]");
         }
         dl.setPrice(l.getAmount());
         dl.setTax(l.getTax());
         dl.setEquivalenceSurcharge(l.getReq());
         dl.setLineType(lt);
         dl.setContractPreference(getDefaultContractPreference());
         dl.setStore(defaultStore);
         dl.setLineOrder(count++);
         documentLines.add(dl);
       }
     } else {
       DocumentLine dl = new DocumentLine();
       dl.setDocument(this);
       if(header != null) {
         dl.setConcept(header);
       }
       dl.setPrice(relDoc.getTotalAmount());
       dl.setLineType(lt);
       dl.setContractPreference(getDefaultContractPreference());
       dl.setStore(defaultStore);
       dl.setLineOrder(count++);
       documentLines.add(dl);
     }
   }

Here is the call graph for this function:

◆ appendLines()

void org.turro.financials.entity.Document.appendLines	(	Document	relDoc,
		String	header,
		DocumentWorkflow	workflow
	)

Definition at line 440 of file Document.java.

                                                                                      {
     int count = getMaxLineOrder() + 1;
     if(header != null) {
       Contract defaultStore = getDefaultStore();
       DocumentLine dl = new DocumentLine();
       dl.setDocument(this);
       dl.setConcept(header);
       dl.setStore(defaultStore);
       dl.setLineOrder(count++);
       documentLines.add(dl);
     }
     for(DocumentLine l : relDoc.getDocumentLines()) {
       DocumentLine dl = new DocumentLine();
       dl.setDocument(this);
       dl.setProduct(l.getProduct());
       dl.setProductByContractor(l.getProductByContractor());
       dl.setConcept(l.getConcept());
       dl.setQuantity(l.getQuantity());
       dl.setPrice(l.getPrice());
       dl.setDiscountPerCent(l.getDiscountPerCent());
       dl.setDiscountMoney(l.getDiscountMoney());
       dl.setTax(l.getTax());
       dl.setEquivalenceSurcharge(l.getEquivalenceSurcharge());
       dl.setRetention(l.getRetention());
       dl.setStore(l.getStore());
       dl.setLineOrder(count++);
       if(l.getLineType() != null) {
         double sc = l.getLineType().getStockCoefficient();
         dl.setLineType(workflow == null ? null : workflow.getLineType());
         if(dl.getLineType() == null) {
           for(RelatedLineType rlt : getDocumentDefinition().getRelatedLineTypes()) {
             if((sc == 0 && rlt.getLineType().getStockCoefficient() != 0) ||
                     (sc != 0 && rlt.getLineType().getStockCoefficient() == 0)) {
               dl.setLineType(rlt.getLineType());
               break;
             }
           }
         }
         if(dl.getLineType() == null) {
           dl.setLineType(getDefaultLineType());
         }
       } else {
         dl.setLineType(null);
       }
       if(workflow == null) {
         dl.setContractPreference(getDefaultContractPreference());
       } else {
         dl.setContractPreference(l.getContractPreference());
       }
       documentLines.add(dl);
     }
   }

Here is the call graph for this function:

◆ assignTableOrder()

void org.turro.financials.entity.Document.assignTableOrder ( Collection< DocumentLine > lines )

Definition at line 380 of file Document.java.

                                                                {
     Iterator<DocumentLine> it = lines.iterator();
     int c = 0;
     while(it.hasNext()) {
       it.next().setLineOrder(c++);
     }
   }

◆ backFrom()

void org.turro.financials.entity.Document.backFrom	(	Document	doc,
		String	header,
		DocumentWorkflow	workflow
	)

Definition at line 560 of file Document.java.

                                                                                {
     Date now = new Date();
     setContract(doc.getContract());
     setCurrency(doc.getCurrency());
     setDocumentDate(now);
     setDocumentNumber(null);
     setReceiptDate(now);
     setDocumentDefinition(workflow.getAncestor());
     setDraft(doc.isDraft());
     setNotes(doc.getNotes());
     if(workflow.getAncestor().hasDetail() && workflow.getDescendant().hasDetail()) {
       appendLines(doc, header, null);
     } else {
       appendAmounts(doc, header, null);
     }
     DocumentRelation dr = new DocumentRelation();
     dr.setAncestor(this);
     dr.setDescendant(doc);
     getDescendants().add(dr);
   }

Here is the call graph for this function:

◆ clearEmpties()

void org.turro.financials.entity.Document.clearEmpties ( )

Definition at line 371 of file Document.java.

                              {
     Iterator<DocumentLine> itl = getDocumentLines().iterator();
     while(itl.hasNext()) {
       if(itl.next().isEmpty()) {
         itl.remove();
       }
     }
   }

Here is the caller graph for this function:

◆ collections()

Collection<Collection> org.turro.financials.entity.Document.collections ( )

Implements org.turro.jpa.entity.IDaoEntity.

Definition at line 322 of file Document.java.

                                               {
     return List.of(getRegisters());
   }

◆ copyFrom()

void org.turro.financials.entity.Document.copyFrom	(	Document	doc,
		boolean	shallowCopy
	)

Definition at line 581 of file Document.java.

                                                           {
     if(!shallowCopy) {
       setContract(doc.getContract());
     }
     setCurrency(doc.getCurrency());
     setDocumentDate(doc.getDocumentDate());
     setDocumentNumber(doc.getDocumentNumber() + "*");
     setReceiptDate(doc.getReceiptDate());
     setDocumentDefinition(doc.getDocumentDefinition());
     setDraft(true);
     setNotes(doc.getNotes());
     setForcedView(doc.getForcedView());
     Contract defaultStore = (!shallowCopy) ? null : getDefaultStore();
     for(DocumentLine dl : doc.getDocumentLines()) {
       DocumentLine nl = new DocumentLine();
       nl.setConcept(dl.getConcept());
       nl.setDiscountMoney(dl.getDiscountMoney());
       nl.setDiscountPerCent(dl.getDiscountPerCent());
       nl.setDocument(this);
       nl.setLineOrder(dl.getLineOrder());
       nl.setLineType(dl.getLineType());
       nl.setContractPreference(dl.getContractPreference());
       nl.setPrice(dl.getPrice());
       nl.setProduct(dl.getProduct());
       nl.setProductByContractor(dl.getProductByContractor());
       nl.setQuantity(dl.getQuantity());
       nl.setStore(shallowCopy ? defaultStore : dl.getStore());
       nl.setTax(dl.getTax());
       nl.setEquivalenceSurcharge(dl.getEquivalenceSurcharge());
       nl.setRetention(dl.getRetention());
       documentLines.add(nl);
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doAction()

Object org.turro.financials.entity.Document.doAction	(	Date	now,
		String	data
	)

Implements org.turro.plugin.scheduler.ScheduledAction.

Definition at line 764 of file Document.java.

                                                 {
     if(data.contains("action:clone")) {
       Document nd = new Document();
       nd.copyFrom(this, false);
       nd.setDocumentDate(now);
       nd.setReceiptDate(now);
       if(nd.getDocumentDefinition().isAutoNumbered()) {
         nd.setDocumentNumber(null);
       }
       nd.setDraft(data.contains("clone:draft"));
       nd.prepareSave();
       return new FinancialsPU().saveObject(nd);
     }
     return null;
   }

Here is the call graph for this function:

◆ entityId()

Object org.turro.financials.entity.Document.entityId ( )

Implements org.turro.jpa.entity.IDaoEntity.

Definition at line 279 of file Document.java.

                            {
     return id;
   }

◆ flowFrom()

void org.turro.financials.entity.Document.flowFrom	(	Document	doc,
		String	header,
		DocumentWorkflow	workflow
	)

Definition at line 539 of file Document.java.

                                                                                {
     Date now = new Date();
     setContract(doc.getContract());
     setCurrency(doc.getCurrency());
     setDocumentDate(now);
     setDocumentNumber(null);
     setReceiptDate(now);
     setDocumentDefinition(workflow.getDescendant());
     setDraft(doc.isDraft());
     setNotes(doc.getNotes());
     if(workflow.getAncestor().hasDetail() && workflow.getDescendant().hasDetail()) {
       appendLines(doc, header, workflow);
     } else {
       appendAmounts(doc, header, workflow);
     }
     DocumentRelation dr = new DocumentRelation();
     dr.setAncestor(doc);
     dr.setDescendant(this);
     getAncestors().add(dr);
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActualHqContacts()

Collection<Contact> org.turro.financials.entity.Document.getActualHqContacts ( )

Definition at line 646 of file Document.java.

                                                    {
     ContactList l = new ContactList();
     for(DocumentLine line : getDocumentLines()) {
       if(!line.isEmpty()) {
         Contract ctc = line.getStore();
         if(ctc != null && ctc.getDepartment() != null && ctc.getDepartment().getHeadquarters() != null) {
           l.add((Contact) ctc.getDepartment().getHeadquarters().getIContact().getContact());
         }
       }
     }
     return l;
   }

Here is the call graph for this function:

◆ getAmounts()

DocumentAmounts org.turro.financials.entity.Document.getAmounts ( )

Definition at line 388 of file Document.java.

                                       {
     return new DocumentAmounts(this);
   }

Here is the caller graph for this function:

◆ getAmountsByBook()

DocumentAmountsByBook org.turro.financials.entity.Document.getAmountsByBook ( BookDefinition bookDefinition )

Definition at line 392 of file Document.java.

                                                                                {
     return new DocumentAmountsByBook(this, bookDefinition);
   }

◆ getAncestors()

Set<DocumentRelation> org.turro.financials.entity.Document.getAncestors ( )

Definition at line 107 of file Document.java.

                                               {
     Dao dao = new FinancialsPU();
     if(id > 0 && dao.isNotLoaded(ancestors)) {
       ancestors = dao.lazyLoader(Document.class, this, "ancestors").ancestors;
     }
     return ancestors;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBookNumber()

long org.turro.financials.entity.Document.getBookNumber ( )

Definition at line 782 of file Document.java.

                               {
     if(!getRegisters().isEmpty()) {
       Register register = getRegisters().iterator().next();
       if(!register.getBookRegisters().isEmpty()) {
         return register.getBookRegisters().iterator().next().getBookOrder();
       }
     }
     return 0L;
   }

Here is the call graph for this function:

◆ getCleanFullNotes()

String org.turro.financials.entity.Document.getCleanFullNotes ( )

Definition at line 354 of file Document.java.

                                     {
     return HtmlContent.noTags(MailUtils.cleanLinks(getFullNotes()));
   }

Here is the call graph for this function:

◆ getConcept()

String org.turro.financials.entity.Document.getConcept ( )

Definition at line 346 of file Document.java.

                              {
     PhraseBuilder pb = new PhraseBuilder();
     for(DocumentLine dl : documentLines) {
       pb.addWord(dl.getConcept());
     }
     return pb.toString();
   }

◆ getContract()

Contract org.turro.financials.entity.Document.getContract ( )

Definition at line 119 of file Document.java.

                                 {
     return contract;
   }

Here is the caller graph for this function:

◆ getContractFlows()

Collection<ContractFlow> org.turro.financials.entity.Document.getContractFlows ( )

Definition at line 615 of file Document.java.

                                                      {
     return contract == null ? null : contract.getFlowFor(this);
   }

Here is the caller graph for this function:

◆ getCurrency()

Currency org.turro.financials.entity.Document.getCurrency ( )

Definition at line 128 of file Document.java.

                                 {
     if(currency == null && contract != null) {
       currency = contract.getCurrency();
     }
     return currency;
   }

Here is the caller graph for this function:

◆ getDefaultContractPreference()

ContractPreference org.turro.financials.entity.Document.getDefaultContractPreference ( )

Definition at line 429 of file Document.java.

                                                            {
     if(getContract() != null) {
       if(getContract().getContractPreferences().isEmpty()) {
         return getContract().getContractDefinition().getDefaultContractPreference();
       } else {
         return getContract().getContractPreferences().iterator().next();
       }
     }
     return null;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultLineType()

LineType org.turro.financials.entity.Document.getDefaultLineType ( )

Definition at line 717 of file Document.java.

                                        {
     LineType lt = null;
     if(getDocumentDefinition() != null) {
       for(RelatedLineType rlt : getDocumentDefinition().getRelatedLineTypes()) {
         if(rlt.isDefaultLineType()) {
           for(LineType l : getLineTypes()) {
             if(rlt.getLineType().getId() == l.getId()) {
               return l;
             }
             if(lt == null) lt = l;
           }
         }
       }
     }
     return lt;
   }

Here is the caller graph for this function:

◆ getDefaultStore()

Contract org.turro.financials.entity.Document.getDefaultStore ( )

Definition at line 689 of file Document.java.

                                     {
     Collection<Contract> stores = getStores();
     if(!stores.isEmpty()) {
       return stores.iterator().next();
     }
     return null;
   }

◆ getDescendants()

Set<DocumentRelation> org.turro.financials.entity.Document.getDescendants ( )

Definition at line 139 of file Document.java.

                                                 {
     Dao dao = new FinancialsPU();
     if(id > 0 && dao.isNotLoaded(descendants)) {
       descendants = dao.lazyLoader(Document.class, this, "descendants").descendants;
     }
    return descendants;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDocDescription()

String org.turro.financials.entity.Document.getDocDescription ( )

Definition at line 659 of file Document.java.

                                     {
     return getDocumentDefinition().getName() + ": " +
               (getForcedView() == null ? "" : "(" + getForcedView().getName() + ") ") +
               getDocumentNumber() + " " +
               SimpleDateFormat.getDateInstance().format(documentDate);
   }

Here is the caller graph for this function:

◆ getDocumentDate()

Date org.turro.financials.entity.Document.getDocumentDate ( )

Definition at line 159 of file Document.java.

                                 {
     return documentDate;
   }

Here is the caller graph for this function:

◆ getDocumentDefinition()

DocumentDefinition org.turro.financials.entity.Document.getDocumentDefinition ( )

Definition at line 167 of file Document.java.

                                                     {
     Dao dao = new FinancialsPU();
     if(id > 0 && dao.isNotLoaded(documentDefinition)) {
       setDocumentDefinition(dao.lazyLoader(Document.class, this, "documentDefinition").documentDefinition);
     }
     return documentDefinition;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDocumentLines()

Set<DocumentLine> org.turro.financials.entity.Document.getDocumentLines ( )

Definition at line 180 of file Document.java.

                                               {
     return documentLines;
   }

Here is the caller graph for this function:

◆ getDocumentNumber()

String org.turro.financials.entity.Document.getDocumentNumber ( )

Definition at line 188 of file Document.java.

                                     {
     return documentNumber;
   }

Here is the caller graph for this function:

◆ getDocumentString()

String org.turro.financials.entity.Document.getDocumentString ( )

Definition at line 666 of file Document.java.

                                     {
     return getDocumentDefinition().getName() + " " + documentNumber + " " +
             SimpleDateFormat.getDateInstance().format(documentDate);
   }

Here is the caller graph for this function:

◆ getForcedView()

RegisterView org.turro.financials.entity.Document.getForcedView ( )

Definition at line 204 of file Document.java.

                                       {
     return forcedView;
   }

Here is the caller graph for this function:

◆ getFullNotes()

String org.turro.financials.entity.Document.getFullNotes ( )

Definition at line 358 of file Document.java.

                                {
     PhraseBuilder pb = new PhraseBuilder();
     pb.addWord(notes);
 //    pb.addPendingSeparator(Chars.nl().repeat(2).toString());
 //    pb.addWord(getContract().getNotes());
     pb.addPendingSeparator(Chars.nl().repeat(2).toString());
     ContractDefinitionNotes cdNotes = getContract().getContractDefinition().getNotes();
     if(cdNotes != null) {
       pb.addWord(cdNotes.getNotes());
     }
     return pb.toString();
   }

Here is the call graph for this function:

◆ getId()

long org.turro.financials.entity.Document.getId ( )

Definition at line 212 of file Document.java.

                       {
     return id;
   }

Here is the caller graph for this function:

◆ getLineTypes()

Collection<LineType> org.turro.financials.entity.Document.getLineTypes ( )

Definition at line 734 of file Document.java.

                                              {
     LineTypeSet result = new LineTypeSet();
     if(getDocumentDefinition() != null && contract != null) {
       LineTypeSet lts = new RelatedToLineTypeAdapter(getDocumentDefinition().getRelatedLineTypes());
       for(LineType lt : lts) {
         if(lt.getName().contains("%n")) {
           if(contract.getContractPreferences().isEmpty()) {
             LineType ltt = lt.clone();
             ltt.setContractPreference(getDefaultContractPreference());
             result.add(ltt);
           } else {
             for(ContractPreference cp : contract.getContractPreferences()) {
               LineType ltt = lt.clone();
               ltt.setContractPreference(cp);
               result.add(ltt);
             }
           }
         } else {
           LineType ltt = lt.clone();
           ltt.setContractPreference(getDefaultContractPreference());
           result.add(ltt);
         }
       }
     }
     return result;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMaxLineOrder()

int org.turro.financials.entity.Document.getMaxLineOrder ( )

Definition at line 697 of file Document.java.

                                {
     int result = 0;
     for(DocumentLine dl : getDocumentLines()) {
       if(dl.getLineOrder() > result) {
         result = dl.getLineOrder();
       }
     }
     return result;
   }

Here is the caller graph for this function:

◆ getNotes()

String org.turro.financials.entity.Document.getNotes ( )

Definition at line 236 of file Document.java.

                            {
     return notes;
   }

Here is the caller graph for this function:

◆ getQuote()

double org.turro.financials.entity.Document.getQuote ( )

Definition at line 244 of file Document.java.

                            {
     return quote;
   }

◆ getReceiptDate()

Date org.turro.financials.entity.Document.getReceiptDate ( )

Definition at line 252 of file Document.java.

                                {
     return receiptDate;
   }

Here is the caller graph for this function:

◆ getRegisters()

Set<Register> org.turro.financials.entity.Document.getRegisters ( )

Definition at line 260 of file Document.java.

                                       {
     return registers;
   }

Here is the caller graph for this function:

◆ getRelated()

IElephantEntity org.turro.financials.entity.Document.getRelated ( )

Definition at line 328 of file Document.java.

                                       {
     return Entities.getController(relatedPath);
   }

Here is the call graph for this function:

◆ getRelatedPath()

String org.turro.financials.entity.Document.getRelatedPath ( )

Definition at line 268 of file Document.java.

                                  {
     return relatedPath;
   }

◆ getSerializerMappings()

MappingSet org.turro.financials.entity.Document.getSerializerMappings ( )

Definition at line 829 of file Document.java.

                                             {
     MappingSet set = new MappingSet();
     set.addMapping(Document.class, 1, 
             new String[] { "id", "documentNumber", "documentDate" }, 
             new String[] { "documentDefinition", "notes", "receiptDate", "draft", "documentLines", 
               "currency", "contract", "forcedView", "relatedPath", "ancestors", "descendants", "registers",
               "conciliateRegister", "regularizeVAT", "regularizeIRPF", "noAncestors", "noDescendants" });
     set.addMapping(DocumentDefinition.class, 2,
             new String[] { "id", "name" }, 
             null);
     set.addMapping(Contract.class, 2,
             new String[] { "id", "name" }, 
             null);
     set.addMapping(RegisterView.class, 2,
             new String[] { "id", "name" }, 
             null);
     set.addMapping(DocumentRelation.class, 2,
             null, 
             new String[] { "ancestor", "descendant" });
     set.addMapping(Document.class, 3, 
             new String[] { "id" }, 
             null);
     set.addMapping(DocumentLine.class, 2,
             new String[] { "quantity", "price", "tax", "retention", "discountPerCent", "discountMoney" }, 
             new String[] { "concept", "product", "productByContractor", "store", 
               "lineType", "contractPreference"});
     set.addMapping(Product.class, 3,
             new String[] { "id", "productCode" }, 
             new String[] { "description" });
     set.addMapping(ProductByContractor.class, 3,
             new String[] { "contractorCode" }, 
             new String[] { "contract" });
     set.addMapping(Contract.class, 4,
             new String[] { "id", "name" }, 
             null);
     set.addMapping(Contract.class, 3,
             new String[] { "id", "name" }, 
             null);
     set.addMapping(LineType.class, 3,
             new String[] { "name" }, 
             null);
     set.addMapping(ContractPreference.class, 3,
             new String[] { "name" }, 
             null);
 //    set.addMapping(Register.class, 2,
 //            new String[] { "idRegister", "registerDate" }, 
 //            new String[] { "view", "registerEntries" });
 //    set.addMapping(RegisterView.class, 3,
 //            new String[] { "id", "name" }, 
 //            null);
 //    set.addMapping(RegisterEntry.class, 3,
 //            new String[] { "debit", "credit", "approved", "conciliated" }, 
 //            new String[] { "account" } );
 //    set.addMapping(Account.class, 4,
 //            new String[] { "id", "description" }, 
 //            null);
     return set;
   }

◆ getStores()

Collection<Contract> org.turro.financials.entity.Document.getStores ( )

Definition at line 676 of file Document.java.

                                           {
     if(_stores == null) {
       _stores = new DocumentDefinitionWrapper(getDocumentDefinition())
               .getRelatedStores(getContract());
       if(_stores.isEmpty()) {
         _stores = new DocumentDefinitionWrapper(getDocumentDefinition())
               .getRelatedStores();
       }
       ContractWrapper.clearInactives(_stores);
     }
     return _stores;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSubTotal()

double org.turro.financials.entity.Document.getSubTotal ( )

Definition at line 421 of file Document.java.

                               {
     return getAmounts().getAmount();
   }

◆ getTotalAmount()

double org.turro.financials.entity.Document.getTotalAmount ( )

Definition at line 425 of file Document.java.

                                  {
     return getAmounts().getTotal();
   }

Here is the caller graph for this function:

◆ getUpdatedDescendants()

Set<DocumentRelation> org.turro.financials.entity.Document.getUpdatedDescendants ( )

Definition at line 147 of file Document.java.

                                                        {
     Dao dao = new FinancialsPU();
     if(id > 0) {
       descendants = dao.lazyLoader(Document.class, this, "descendants").descendants;
     }
     return descendants;
   }

◆ getUsualPath()

String org.turro.financials.entity.Document.getUsualPath ( )

Definition at line 708 of file Document.java.

                                {
     if(contract != null && getDocumentDefinition() != null) {
       return contract.getUsualPath(getDocumentDefinition());
     }
     return "";
   }

Here is the caller graph for this function:

◆ getWorkflows() [1/2]

Collection<DocumentWorkflow> org.turro.financials.entity.Document.getWorkflows ( )

Definition at line 619 of file Document.java.

                                                      {
     return getWorkflows(true, true);
   }

◆ getWorkflows() [2/2]

Collection<DocumentWorkflow> org.turro.financials.entity.Document.getWorkflows	(	boolean	forward,
		boolean	missing
	)

Definition at line 623 of file Document.java.

                                                                                      {
     if(forward && (!missing || getDescendants().isEmpty())) {
       return new FinancialsPU().getResultList(
               "select dw from DocumentWorkflow as dw " +
               "where dw.ancestor = ? " +
               "and dw.contractDefinition = ?",
               new Object[] {
                 getDocumentDefinition(),
                 contract.getContractDefinition()
               });
     } else if(!forward && (!missing || getAncestors().isEmpty())) {
       return new FinancialsPU().getResultList(
               "select dw from DocumentWorkflow as dw " +
               "where dw.descendant = ? " +
               "and dw.contractDefinition = ?",
               new Object[] {
                 getDocumentDefinition(),
                 contract.getContractDefinition()
               });
     }
     return Collections.EMPTY_LIST;
   }

◆ isBlank()

boolean org.turro.financials.entity.Document.isBlank ( )

Definition at line 336 of file Document.java.

                            {
     Iterator<DocumentLine> itl = getDocumentLines().iterator();
     while(itl.hasNext()) {
       if(!itl.next().isEmpty()) {
         return false;
       }
     }
     return true;
   }

◆ isConciliateRegister()

boolean org.turro.financials.entity.Document.isConciliateRegister ( )

Definition at line 797 of file Document.java.

                                         {
     return conciliateRegister;
   }

◆ isDraft()

boolean org.turro.financials.entity.Document.isDraft ( )

Definition at line 196 of file Document.java.

                            {
     return draft;
   }

Here is the caller graph for this function:

◆ isEmpty()

boolean org.turro.financials.entity.Document.isEmpty ( )

Implements org.turro.jpa.entity.IDaoEntity.

Definition at line 284 of file Document.java.

                            {
     return documentLines.isEmpty() ||
             isBlank() ||
             !isValid() ||
             documentDate == null ||
             receiptDate == null;
   }

Here is the caller graph for this function:

◆ isNoAncestors()

boolean org.turro.financials.entity.Document.isNoAncestors ( )

Definition at line 220 of file Document.java.

                                  {
     return noAncestors;
   }

◆ isNoDescendants()

boolean org.turro.financials.entity.Document.isNoDescendants ( )

Definition at line 228 of file Document.java.

                                    {
     return noDescendants;
   }

◆ isRegularizeIRPF()

boolean org.turro.financials.entity.Document.isRegularizeIRPF ( )

Definition at line 819 of file Document.java.

                                     {
     return regularizeIRPF;
   }

◆ isRegularizeVAT()

boolean org.turro.financials.entity.Document.isRegularizeVAT ( )

Definition at line 808 of file Document.java.

                                    {
     return regularizeVAT;
   }

◆ isValid()

boolean org.turro.financials.entity.Document.isValid ( )

Definition at line 332 of file Document.java.

                            {
     return !(contract == null || getDocumentDefinition() == null);
   }

Here is the caller graph for this function:

◆ prepareSave()

void org.turro.financials.entity.Document.prepareSave ( )

Implements org.turro.jpa.entity.IDaoEntity.

Definition at line 293 of file Document.java.

                             {
     IDaoEntity.super.prepareSave();
     if(Strings.isBlank(documentNumber)) {
       // Ensure not null value
       if(draft) {
         documentNumber = "";
       } else {
         if(forcedView == null) {
           documentNumber = IdUtils.getMaxLongIdFromString(
                   new FinancialsPU(), "Document", "documentNumber",
                   new String[] {
                     "year(receiptDate) = " + new CheckDate(receiptDate).getYear(),
                     "documentDefinition_identifier = " + getDocumentDefinition().getId(),
                     "forcedView_identifier is null"
                   }) + "";
         } else {
           documentNumber = IdUtils.getMaxLongIdFromString(
                   new FinancialsPU(), "Document", "documentNumber",
                   new String[] {
                     "year(receiptDate) = " + new CheckDate(receiptDate).getYear(),
                     "documentDefinition_identifier = " + getDocumentDefinition().getId(),
                     "forcedView_identifier = " + forcedView.getId()
                   }) + "";
         }
       }
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAncestors()

void org.turro.financials.entity.Document.setAncestors ( Set< DocumentRelation > ancestors )

Definition at line 115 of file Document.java.

                                                             {
     this.ancestors = ancestors;
   }

◆ setConciliateRegister()

void org.turro.financials.entity.Document.setConciliateRegister ( boolean conciliateRegister )

Definition at line 801 of file Document.java.

                                                                 {
     this.conciliateRegister = conciliateRegister;
   }

◆ setContract()

void org.turro.financials.entity.Document.setContract ( Contract contract )

Definition at line 123 of file Document.java.

                                              {
     this.contract = contract;
     _stores = null;
   }

Here is the caller graph for this function:

◆ setCurrency()

void org.turro.financials.entity.Document.setCurrency ( Currency currency )

Definition at line 135 of file Document.java.

                                              {
     this.currency = currency;
   }

Here is the caller graph for this function:

◆ setDescendants()

void org.turro.financials.entity.Document.setDescendants ( Set< DocumentRelation > descendants )

Definition at line 155 of file Document.java.

                                                                 {
     this.descendants = descendants;
   }

◆ setDocumentDate()

void org.turro.financials.entity.Document.setDocumentDate ( Date documentDate )

Definition at line 163 of file Document.java.

                                                  {
     this.documentDate = documentDate;
   }

Here is the caller graph for this function:

◆ setDocumentDefinition()

void org.turro.financials.entity.Document.setDocumentDefinition ( DocumentDefinition documentDefinition )

Definition at line 175 of file Document.java.

                                                                            {
     this.documentDefinition = documentDefinition;
     _stores = null;
   }

Here is the caller graph for this function:

◆ setDocumentLines()

void org.turro.financials.entity.Document.setDocumentLines ( Set< DocumentLine > documentLines )

Definition at line 184 of file Document.java.

                                                                 {
     this.documentLines = documentLines;
   }

◆ setDocumentNumber()

void org.turro.financials.entity.Document.setDocumentNumber ( String documentNumber )

Definition at line 192 of file Document.java.

                                                        {
     this.documentNumber = documentNumber;
   }

Here is the caller graph for this function:

◆ setDraft()

void org.turro.financials.entity.Document.setDraft ( boolean draft )

Definition at line 200 of file Document.java.

                                       {
     this.draft = draft;
   }

Here is the caller graph for this function:

◆ setForcedView()

void org.turro.financials.entity.Document.setForcedView ( RegisterView forcedView )

Definition at line 208 of file Document.java.

                                                      {
     this.forcedView = forcedView;
   }

◆ setId()

void org.turro.financials.entity.Document.setId ( long id )

Definition at line 216 of file Document.java.

                              {
     this.id = id;
   }

◆ setNoAncestors()

void org.turro.financials.entity.Document.setNoAncestors ( boolean noAncestors )

Definition at line 224 of file Document.java.

                                                   {
     this.noAncestors = noAncestors;
   }

◆ setNoDescendants()

void org.turro.financials.entity.Document.setNoDescendants ( boolean noDescendants )

Definition at line 232 of file Document.java.

                                                       {
     this.noDescendants = noDescendants;
   }

◆ setNotes()

void org.turro.financials.entity.Document.setNotes ( String notes )

Definition at line 240 of file Document.java.

                                      {
     this.notes = notes;
   }

Here is the caller graph for this function:

◆ setQuote()

void org.turro.financials.entity.Document.setQuote ( double quote )

Definition at line 248 of file Document.java.

                                      {
     this.quote = quote;
   }

◆ setReceiptDate()

void org.turro.financials.entity.Document.setReceiptDate ( Date receiptDate )

Definition at line 256 of file Document.java.

                                                {
     this.receiptDate = receiptDate;
   }

Here is the caller graph for this function:

◆ setRegisters()

void org.turro.financials.entity.Document.setRegisters ( Set< Register > registers )

Definition at line 264 of file Document.java.

                                                     {
     this.registers = registers;
   }

◆ setRegularizeIRPF()

void org.turro.financials.entity.Document.setRegularizeIRPF ( boolean regularizeIRPF )

Definition at line 823 of file Document.java.

                                                         {
     this.regularizeIRPF = regularizeIRPF;
   }

◆ setRegularizeVAT()

void org.turro.financials.entity.Document.setRegularizeVAT ( boolean regularizeVAT )

Definition at line 812 of file Document.java.

                                                       {
     this.regularizeVAT = regularizeVAT;
   }

◆ setRelatedPath()

void org.turro.financials.entity.Document.setRelatedPath ( String relatedPath )

Definition at line 272 of file Document.java.

                                                  {
     this.relatedPath = relatedPath;
   }

Member Data Documentation

◆ conciliateRegister

transient boolean org.turro.financials.entity.Document.conciliateRegister

Definition at line 795 of file Document.java.

◆ regularizeIRPF

transient boolean org.turro.financials.entity.Document.regularizeIRPF

Definition at line 817 of file Document.java.

◆ regularizeVAT

transient boolean org.turro.financials.entity.Document.regularizeVAT

Definition at line 806 of file Document.java.

The documentation for this class was generated from the following file:

Document.java

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ appendAmounts()

◆ appendLines()

◆ assignTableOrder()

◆ backFrom()

◆ clearEmpties()

◆ collections()

◆ copyFrom()

◆ doAction()

◆ entityId()

◆ flowFrom()

◆ getActualHqContacts()

◆ getAmounts()

◆ getAmountsByBook()

◆ getAncestors()

◆ getBookNumber()

◆ getCleanFullNotes()

◆ getConcept()

◆ getContract()

◆ getContractFlows()

◆ getCurrency()

◆ getDefaultContractPreference()

◆ getDefaultLineType()

◆ getDefaultStore()

◆ getDescendants()

◆ getDocDescription()

◆ getDocumentDate()

◆ getDocumentDefinition()

◆ getDocumentLines()

◆ getDocumentNumber()

◆ getDocumentString()

◆ getForcedView()

◆ getFullNotes()

◆ getId()

◆ getLineTypes()

◆ getMaxLineOrder()

◆ getNotes()

◆ getQuote()

◆ getReceiptDate()

◆ getRegisters()

◆ getRelated()

◆ getRelatedPath()

◆ getSerializerMappings()

◆ getStores()

◆ getSubTotal()

◆ getTotalAmount()

◆ getUpdatedDescendants()

◆ getUsualPath()

◆ getWorkflows() [1/2]

◆ getWorkflows() [2/2]

◆ isBlank()

◆ isConciliateRegister()

◆ isDraft()

◆ isEmpty()

◆ isNoAncestors()

◆ isNoDescendants()

◆ isRegularizeIRPF()

◆ isRegularizeVAT()

◆ isValid()

◆ prepareSave()

◆ setAncestors()

◆ setConciliateRegister()

◆ setContract()

◆ setCurrency()

◆ setDescendants()

◆ setDocumentDate()

◆ setDocumentDefinition()

◆ setDocumentLines()

◆ setDocumentNumber()

◆ setDraft()

◆ setForcedView()

◆ setId()

◆ setNoAncestors()

◆ setNoDescendants()

◆ setNotes()

◆ setQuote()

◆ setReceiptDate()