org.sistema.cs.doc.persist

Class DocItemized

java.lang.Object

org.sistema.persist.Persistent

org.sistema.cs.doc.persist.Doc

org.sistema.cs.doc.persist.DocItemized

All Implemented Interfaces:

java.io.Serializable, IDoc, IDocItemized, org.sistema.persist.IPersistent

Direct Known Subclasses:

DocValued, SaleDocument

public class DocItemized
extends Doc
implements IDocItemized

A document containing items.

Since:

31-dec-2011

Version:

1.6 19-jan-2020 Juan Díaz

Author:

Juan Díaz

See Also:

Serialized Form

Field Summary

Fields inherited from class org.sistema.persist.Persistent

attributes, STATE_DELETABLE, STATE_DELETED, STATE_NEW

Constructor Summary

Constructors

Constructor and Description
DocItemized()

Method Summary

Modifier and Type	Method and Description
void	add(java.util.Collection<IDocItem> docItems) Adds a collection of items to the document.
boolean	add(IDocItem docItem) New items (those not yet saved to persistent store) won't have an id, so we use the order of the item is used as the index.
boolean	clearItems() Clears all document-item relations set on the document.
java.math.BigDecimal	getAmount()
java.util.Collection<IDocItem>	getDocItems()
void	setDocItems(java.util.Collection<IDocItem> di) Sets document-items of this document.
java.lang.String	toString()

Methods inherited from class org.sistema.cs.doc.persist.Doc

add, addSource, addTarget, getCurrency, getDate, getEntry, getId, getNumber, getRelatedDocs, getStatus, getTime, getType, isStatus, setCurrency, setDate, setEntry, setId, setNumber, setStatus, setTime, setType

Methods inherited from class org.sistema.persist.Persistent

addAttribute, addAttribute, equals, getAttribute, getAttributeMaximumLength, getAttributeMinimumLength, getAttributeValue, getField, getFieldFlagValue, getFieldNames, getFields, getFieldsUnsavedElements, getFieldValue, getPrimaryKey, getValue, hasUnsavedElements, isAttributeEditable, isAttributeRequired, isAttributeVisible, isAttributeVisible, isDeletable, isDeleted, isEditable, isFieldModified, isFieldState, isModified, isModifiedBase, isNew, setAttributeValue, setDeletable, setDeleted, setFieldFlag, setFieldState, setFieldValue, setNew

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sistema.cs.doc.persist.IDoc

add, addSource, addTarget, getDate, getEntry, getId, getNumber, getRelatedDocs, getStatus, getTime, getType, isStatus, setDate, setEntry, setId, setNumber, setStatus, setTime, setType

Constructor Detail

DocItemized

public DocItemized()

Method Detail

add

public void add(java.util.Collection<IDocItem> docItems)

Description copied from interface: IDocItemized

Adds a collection of items to the document.

Specified by:

add in interface IDocItemized

Parameters:

docItems - Document-item relationships to be added to the existing list of relationship.

Since:

v1.4

add

public boolean add(IDocItem docItem)

New items (those not yet saved to persistent store) won't have an id, so we use the order of the item is used as the index. As a consequence, items must be added in order so the index of any given item will be its order - 1.

Specified by:

add in interface IDocItemized

Parameters:

docItem -

Returns:

true if the item is added to the document.

clearItems

public boolean clearItems()

Description copied from interface: IDocItemized

Clears all document-item relations set on the document.

Specified by:

clearItems in interface IDocItemized

Returns:

true if the items are successfully cleared.

Since:

v1.4

getAmount

public java.math.BigDecimal getAmount()

getDocItems

public java.util.Collection<IDocItem> getDocItems()

Specified by:

getDocItems in interface IDocItemized

Returns:

A collection with all DocumentItem relationships set. If no relationships have been added, a null collection.

See Also:

IDocItem

setDocItems

public void setDocItems(java.util.Collection<IDocItem> di)

Description copied from interface: IDocItemized

Sets document-items of this document.

Existing document-items are cleared by this methods.

Specified by:

setDocItems in interface IDocItemized

Since:

v1.4

toString

public java.lang.String toString()

Overrides:

toString in class Doc

Since:

v1.4