org.sistema.cs.doc.persist

Class Doc

java.lang.Object

org.sistema.persist.Persistent

org.sistema.cs.doc.persist.Doc

All Implemented Interfaces:

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

Direct Known Subclasses:

DocItemized

public class Doc
extends org.sistema.persist.Persistent
implements IDoc

Base implementation of a document.

Since:

17-nov-2005 11:45

Version:

1.11 17-nov-2020 Juan Díaz (Yancuicalco, Tepoztlán).

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
Doc()

Method Summary

Modifier and Type	Method and Description
IDocRelation	add(IDocRelation relation) Adds a document-relationship in which this document is either source or target.
IDocRelation	addSource(IDoc source, IDocRelationType type) Adds a related document as the source of the relationship with this document as the target of the relationship.
IDocRelation	addTarget(IDoc target, IDocRelationType type) Adds a related document as the target of the relationship with this document as the source of the relationship.
org.sistema.jcs.atlas.ICurrency	getCurrency()
java.util.Date	getDate()
org.sistema.cs.agenda.IAgendaEntry	getEntry()
java.lang.Integer	getId()
java.lang.String	getNumber()
java.util.Map<java.lang.Integer,IDocRelation>	getRelatedDocs()
java.lang.Integer	getStatus()
java.util.Date	getTime()
IDocType	getType()
boolean	isStatus(int flag)
void	setCurrency(org.sistema.jcs.atlas.ICurrency currency)
void	setDate(java.util.Date d)
void	setEntry(org.sistema.cs.agenda.IAgendaEntry entry) Sets the agenda entry (customer, supplier, etc.) to which the document belongs to.
void	setId(java.lang.Integer id) Sets the unique identifier of the document.
void	setNumber(java.lang.String n) Sets the document number
void	setStatus(java.lang.Integer status) Sets the status of the document.
void	setTime(java.util.Date t)
void	setType(IDocType type)
java.lang.String	toString()

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

Constructor Detail

Doc

public Doc()

Method Detail

add

public IDocRelation add(IDocRelation relation)

Description copied from interface: IDoc

Adds a document-relationship in which this document is either source or target.

Specified by:

add in interface IDoc

Parameters:

relation - relationship containing the child document.

Returns:

The previous relation associated with the identifier of the relation being supplied.

addSource

public IDocRelation addSource(IDoc source,
                              IDocRelationType type)

Description copied from interface: IDoc

Adds a related document as the source of the relationship with this document as the target of the relationship.

Specified by:

addSource in interface IDoc

Parameters:

source - A source document related to this document.

type - The type of relationship

Returns:

True if the target document is successfully related to this document.

Since:

v1.9

addTarget

public IDocRelation addTarget(IDoc target,
                              IDocRelationType type)

Description copied from interface: IDoc

Adds a related document as the target of the relationship with this document as the source of the relationship.

Specified by:

addTarget in interface IDoc

Parameters:

target - Target document related to this document.

type - The type of relationship

Returns:

True if the target document is successfully related to this document.

Since:

v1.9

getCurrency

public org.sistema.jcs.atlas.ICurrency getCurrency()

getDate

public java.util.Date getDate()

Specified by:

getDate in interface IDoc

Returns:

Date when the document was issued.

getId

public java.lang.Integer getId()

Specified by:

getId in interface IDoc

Specified by:

getId in interface org.sistema.persist.IPersistent

Returns:

The unique identifier of the document.

getEntry

public org.sistema.cs.agenda.IAgendaEntry getEntry()

Specified by:

getEntry in interface IDoc

Returns:

The agenda entry to whom the document belongs to.

getNumber

public java.lang.String getNumber()

Specified by:

getNumber in interface IDoc

Returns:

The number of the document.

getRelatedDocs

public java.util.Map<java.lang.Integer,IDocRelation> getRelatedDocs()

Specified by:

getRelatedDocs in interface IDoc

Returns:

All documents related to this document.

Since:

v1.9

getStatus

public java.lang.Integer getStatus()

Specified by:

getStatus in interface IDoc

Returns:

The status of the document.

getTime

public java.util.Date getTime()

Specified by:

getTime in interface IDoc

Since:

25-oct-2011

getType

public IDocType getType()

Specified by:

getType in interface IDoc

Returns:

The type of the document.

Since:

27-oct-2011

isStatus

public boolean isStatus(int flag)

Specified by:

isStatus in interface IDoc

Returns:

true if the given flag is set, false if not.

Since:

v1.8

setCurrency

public void setCurrency(org.sistema.jcs.atlas.ICurrency currency)

Parameters:

currency -

Since:

27-oct-2011

setEntry

public void setEntry(org.sistema.cs.agenda.IAgendaEntry entry)

Description copied from interface: IDoc

Sets the agenda entry (customer, supplier, etc.) to which the document belongs to.

Specified by:

setEntry in interface IDoc

Parameters:

entry - Agenda entry to which the document belongs to.

Since:

v1.8

setId

public void setId(java.lang.Integer id)

Description copied from interface: IDoc

Sets the unique identifier of the document.

Specified by:

setId in interface IDoc

Parameters:

id - New unique id of the document.

Since:

v1.9

setDate

public void setDate(java.util.Date d)

Specified by:

setDate in interface IDoc

setNumber

public void setNumber(java.lang.String n)

Description copied from interface: IDoc

Sets the document number

Specified by:

setNumber in interface IDoc

Parameters:

n - Number of the document

setTime

public void setTime(java.util.Date t)

Specified by:

setTime in interface IDoc

setStatus

public void setStatus(java.lang.Integer status)

Description copied from interface: IDoc

Sets the status of the document.

Specified by:

setStatus in interface IDoc

Parameters:

status - Status of the document.

Since:

v1.8

setType

public void setType(IDocType type)

Specified by:

setType in interface IDoc

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Since:

version x.x (19-jun-2007)