org.sistema.cs.doc.persist

Interface IDoc

All Known Subinterfaces:

ICOrder, IDocItemized, IDocValued, IInvoice, ISaleDoc

All Known Implementing Classes:

COrder, Doc, DocItemized, DocValued, SaleDocument

public interface IDoc

Fields and operation of a generic document.

Since:

17-oct-2011 (first as DocumentInterface, then as IDocument)

Version:

2.0 19-jan-2020 Juan Díaz, Tepoztlán

Author:

Juan Díaz

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.
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	setDate(java.util.Date date)
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 number) Sets the document number
void	setStatus(java.lang.Integer status) Sets the status of the document.
void	setTime(java.util.Date date)
void	setType(IDocType type)

Method Detail

add

IDocRelation add(IDocRelation relation)

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

Parameters:

relation - relationship containing the child document.

Returns:

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

addSource

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.

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.5

addTarget

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.

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.5

getDate

java.util.Date getDate()

Returns:

Date when the document was issued.

Since:

v1.2

getEntry

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

Returns:

The agenda entry to whom the document belongs to.

getId

java.lang.Integer getId()

Returns:

The unique identifier of the document.

getNumber

java.lang.String getNumber()

Returns:

The number of the document.

getRelatedDocs

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

Returns:

All documents related to this document.

Since:

v1.5

getStatus

java.lang.Integer getStatus()

Returns:

The status of the document.

Since:

v1.3

getTime

java.util.Date getTime()

getType

IDocType getType()

Returns:

The type of the document.

isStatus

boolean isStatus(int flag)

Parameters:

flag -

Returns:

true if the given flag is set.

Since:

v1.3

setDate

void setDate(java.util.Date date)

Parameters:

date -

setEntry

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

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

Parameters:

entry - Agenda entry to which the document belongs to.

Since:

v1.4

setId

void setId(java.lang.Integer id)

Sets the unique identifier of the document.

Parameters:

id - New unique id of the document.

Since:

v1.5

setNumber

void setNumber(java.lang.String number)

Sets the document number

Parameters:

number - Number of the document

Since:

v1.4

setStatus

void setStatus(java.lang.Integer status)

Sets the status of the document.

Parameters:

status - Status of the document.

Since:

v1.4

setTime

void setTime(java.util.Date date)

setType

void setType(IDocType type)