org.sistema.cs.doc.persist

Interface IConcept

All Superinterfaces:

ILocalizedDescription, org.sistema.persist.IPersistent

All Known Implementing Classes:

Concept

public interface IConcept
extends ILocalizedDescription, org.sistema.persist.IPersistent

A document's concept.

Since:

30-jun-2015

Version:

0.1 19-jan-2020 Juan Díaz

Author:

Juan Díaz

Method Summary

Modifier and Type	Method and Description
void	addDocumentType(IDocType typeId) Adds a valid document type for the concept.
java.util.Collection<IDocType>	getDocumentTypes()
java.lang.Integer	getId()
byte	getProductRequired() Determines if the concept requires a product.
boolean	isDocumentTypeValid(java.lang.Integer documentTypeId)
void	setDocumentTypes(java.util.Collection<IDocType> types) Sets the allowed document types for the concept.
void	setId(java.lang.Integer id) Sets the unique identifier of the concept.
void	setProductRequired(byte productRequired) Sets the product required flag.

Methods inherited from interface org.sistema.cs.ILocalizedDescription

getDescription, getDescription, getDescriptions, setDescriptions

Methods inherited from interface org.sistema.persist.IPersistent

getFieldNames, getFields, getFieldValue, isAttributeEditable, isAttributeVisible, isDeleted, isFieldState, isModified, isModifiedBase, isNew, setFieldState, setFieldValue

Method Detail

addDocumentType

void addDocumentType(IDocType typeId)

Adds a valid document type for the concept.

Parameters:

typeId -

getDocumentTypes

java.util.Collection<IDocType> getDocumentTypes()

Returns:

The valid document types for the concept.

getId

java.lang.Integer getId()

Specified by:

getId in interface org.sistema.persist.IPersistent

getProductRequired

byte getProductRequired()

Determines if the concept requires a product.

Returns:

A value indicating if a product is required for the concept: 0: no product is involved in the concept. 1: a product is required for the concept. 2: a product is optional for the concept.

isDocumentTypeValid

boolean isDocumentTypeValid(java.lang.Integer documentTypeId)

Parameters:

documentTypeId -

Returns:

True if the given type identifier is valid for this concept.

setDocumentTypes

void setDocumentTypes(java.util.Collection<IDocType> types)

Sets the allowed document types for the concept.

Parameters:

types -

setId

void setId(java.lang.Integer id)

Sets the unique identifier of the concept.

Parameters:

id -

setProductRequired

void setProductRequired(byte productRequired)

Sets the product required flag.

Parameters:

productRequired - 0: no product is involved in the concept. 1: a product is required for the concept. 2: a product is optional for the concept.