org.sistema.control.module.doc

Class DocUtilities

java.lang.Object

org.sistema.control.module.doc.DocUtilities

Deprecated.

since v1.11, use DocUtilities instead.

public class DocUtilities
extends java.lang.Object

Helper functions for Documents.

Code that processes objects (like calculating an invoice amount) is concentrated in this class (instead of in the persistent object classes) to make the persistent objects class reducing network bandwidth and increasing code security (by avoiding code traveling with the persistent object).

Some functions require a persisntent manager and must be provided before calling them.

Since:

29-nov-2005 11:09

Version:

1.11 19-jan-2020 Juan Díaz

Author:

Juan Díaz

Field Summary

Fields

Modifier and Type	Field and Description
private static org.sistema.persist.PersistentService	persistentManager Deprecated. The manager required to peform queries of persistent objects.

Constructor Summary

Constructors

Constructor and Description
DocUtilities() Deprecated.

Method Summary

Modifier and Type	Method and Description
static java.util.Collection<ItemPercentage>	getDefaultPercentages(java.util.Date date, java.lang.String ticket) Deprecated.
static java.lang.Iterable<IItem>	getItems(IDocumentItemized document) Deprecated. Builds an array with every IItem on the invoice.
static java.util.Collection	getPayments(org.sistema.persist.Persistent document, java.util.Date closingDate) Deprecated. Retrieves the payments
static java.math.BigDecimal	getPercentageAmount(IItem item, java.math.BigDecimal baseAmount, java.math.BigDecimal runningSum, java.lang.Integer percentageId) Deprecated.
static java.lang.Iterable<ItemPercentage>	getPercentages(IDocumentItemized invoice, byte typeId) Deprecated.
static java.util.Collection	getPercentageTypes(IDocumentItemized document) Deprecated. Builds a collection with the percentage types that are set on an invoice.
static java.math.BigDecimal	getSubtotal(IDocumentItemized document) Deprecated. Calculates the subtotal of an invoice based an all it's items value.
static java.lang.Boolean	isDocumentCancelled(org.sistema.persist.Persistent document) Deprecated. Standard way to determine if a document has been cancelled.
static void	setPersistentManager(org.sistema.persist.PersistentService newManager) Deprecated. Sets the persistent manager used by functions of this class to perform queries.

Methods inherited from class java.lang.Object

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

Field Detail

persistentManager

private static org.sistema.persist.PersistentService persistentManager

Deprecated.

The manager required to peform queries of persistent objects.

Constructor Detail

DocUtilities

public DocUtilities()

Deprecated.

Method Detail

getItems

public static java.lang.Iterable<IItem> getItems(IDocumentItemized document)

Deprecated.

Builds an array with every IItem on the invoice.

Parameters:

document -

Returns:

Since:

04-nov-2011

getPayments

public static java.util.Collection getPayments(org.sistema.persist.Persistent document,
                                               java.util.Date closingDate)

Deprecated.

Retrieves the payments

Parameters:

document - Document to retrieve the payments from

closingDate -

Returns:

Since:

v1.3 02-may-2011

getPercentageAmount

public static java.math.BigDecimal getPercentageAmount(IItem item,
                                                       java.math.BigDecimal baseAmount,
                                                       java.math.BigDecimal runningSum,
                                                       java.lang.Integer percentageId)

Deprecated.

Parameters:

item -

baseAmount -

runningSum -

percentageId -

Returns:

getPercentageTypes

public static java.util.Collection getPercentageTypes(IDocumentItemized document)

Deprecated.

Builds a collection with the percentage types that are set on an invoice.

Parameters:

document -

Returns:

A collection with the percentages types present on the items of a document, if any. If the document contains no items or the items don't contain any percentages, an empty collection is returned.

getPercentages

public static java.lang.Iterable<ItemPercentage> getPercentages(IDocumentItemized invoice,
                                                                byte typeId)

Deprecated.

Parameters:

invoice -

typeId -

Returns:

A collection with those percentages with an id equal to typeId or an empty collection when no percentages match.

getSubtotal

public static java.math.BigDecimal getSubtotal(IDocumentItemized document)

Deprecated.

Calculates the subtotal of an invoice based an all it's items value.

Parameters:

document -

Returns:

getDefaultPercentages

public static java.util.Collection<ItemPercentage> getDefaultPercentages(java.util.Date date,
                                                                         java.lang.String ticket)
                                                                  throws java.lang.Exception

Deprecated.

Returns:

An array of ItemPercentages with it's attributes set to the default values on the specified date.

Throws:

java.lang.Exception

isDocumentCancelled

public static java.lang.Boolean isDocumentCancelled(org.sistema.persist.Persistent document)

Deprecated.

Standard way to determine if a document has been cancelled. *

A document is cancelled when the ATTRIBUTE_STAUS_CANCELLED has been set.

Using this method (instead of checking the ATTRIBUTE_STATUS field of a document object) makes maintenance easier (just one place to change the logic when required).

Parameters:

document -

Returns:

Since:

30-jun-2009 20:27

See Also:

DocumentConstants

setPersistentManager

public static void setPersistentManager(org.sistema.persist.PersistentService newManager)

Deprecated.

Sets the persistent manager used by functions of this class to perform queries.

Parameters:

newManager - The persistent manager.

Since:

28-aug-2010