Package com.storedobject.core

Class PrintLogicDefinition

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.PrintLogicDefinition

All Implemented Interfaces:

Displayable, StringFiller, HasId

public class PrintLogicDefinition
extends StoredObject

Define "print logic" instances to be associated with a StoredObject class.

Author:

Syam

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
PrintLogicDefinition()

Method Summary

Modifier and Type	Method	Description
static void	columns(Columns columns)
final Class<? extends StoredObject>	getDataClass()
String	getDataClassName()
static PrintLogicDefinition	getFor(Class<? extends StoredObject> dataCass, String label)
String	getIconName()
String	getLabel()
final Class<? extends Executable>	getLogicClass()
StreamData	getODTFormat()
Id	getODTFormatId()
String	getPrintLogicClassName()
boolean	getSpecial()
static void	indices(Indices indices)
static String[]	links()
static ObjectIterator<PrintLogicDefinition>	listFor(Class<? extends StoredObject> dataCass, boolean includeSpecial)
static ObjectIterator<PrintLogicDefinition>	listFor(Class<? extends StoredObject> dataCass, String applicableDataLogicName)
void	setDataClassName(String dataClassName)
void	setIconName(String iconName)
void	setLabel(String label)
void	setODTFormat(Id oDTFormatId)
void	setODTFormat(StreamData format)
void	setODTFormat(BigDecimal idValue)
void	setPrintLogicClassName(String printLogicClassName)
void	setSpecial(boolean special)
void	validateData(TransactionManager tm)	This will be invoked by the system whenever the object is saved to the DB.

Methods inherited from class com.storedobject.core.StoredObject

addLink, addLink, addLink, addLink, addLink, addLink, addLink, addLink, checkCurrency, checkCurrency, checkForDuplicate, checkForDuplicate, checkTimeZone, checkTransaction, clearObjectLinks, contemporary, copy, copy, count, count, count, count, count, count, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, create, created, delete, delete, delete, deleted, directUpdate, equals, exists, exists, exists, exists, exists, existsFileData, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsMaster, existsMaster, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, family, family, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getAttachment, getAttachmentId, getChildren, getDeleted, getDeleted, getExistsCondition, getExistsCondition, getFileData, getFileData, getHistorical, getId, getKeyIndex, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getNotExistsCondition, getNotExistsCondition, getParent, getParent, getParent, getParentId, getParentId, getParentId, getRelated, getRelated, getTransaction, getTransactionId, getTransactionIP, getUnique, getUniqueCondition, hashCode, inserted, isModified, isVirtual, list, list, list, list, list, list, list, list, list, list, list, list, list, listFileData, listFileData, listHistory, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listTree, listTree, listTree, listTree, listViaQuery, listViaQuery, load, load, load, load, loaded, loading, makeNew, makeVirtual, migrate, moduleName, nextVersion, objectLink, objectLink, objectLink, objectLinks, objectLinks, old, person, previousVersion, previousVersion, query, query, query, query, query, query, query, query, query, query, query, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, reload, reload, reloaded, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeReverseLinks, removeReverseLinks, save, save, save, save, save, save, save, save, save, save, save, save, save, save, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, toString, transacting, undelete, undelete, undeleted, updated, user, userId, validate, validateChildAttach, validateChildDetach, validateChildUpdate, validateDelete, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals

Methods inherited from class java.lang.Object

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

Constructor Details

PrintLogicDefinition

public PrintLogicDefinition()

Method Details

columns

public static void columns(Columns columns)

indices

public static void indices(Indices indices)

links

public static String[] links()

setDataClassName

public void setDataClassName(String dataClassName)

getDataClassName

@Column(order=100)
public String getDataClassName()

setLabel

public void setLabel(String label)

getLabel

@Column(order=200)
public String getLabel()

setIconName

public void setIconName(String iconName)

getIconName

@Column(required=false,
        order=300)
public String getIconName()

setPrintLogicClassName

public void setPrintLogicClassName(String printLogicClassName)

getPrintLogicClassName

@Column(order=400,
        caption="Logic(Device, Object)")
public String getPrintLogicClassName()

setODTFormat

public void setODTFormat(Id oDTFormatId)

setODTFormat

public void setODTFormat(BigDecimal idValue)

setODTFormat

public void setODTFormat(StreamData format)

getODTFormatId

@Column(style="(FILE)",
        required=false,
        order=500)
public Id getODTFormatId()

getODTFormat

public StreamData getODTFormat()

setSpecial

public void setSpecial(boolean special)

getSpecial

@Column(order=600)
public boolean getSpecial()

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Description copied from class: StoredObject

This will be invoked by the system whenever the object is saved to the DB. It will be invoked in all cases, while creating new objects and updating/deleting/un-deleting existing objects. If any exception is raised by this method, the process of saving to the DB will be abandoned.

Note: This method is mainly used to validate the data of all attributes of the object, and it may be used by others for validating the object. For example, front-end data-entry systems can use this method for validating the object.

Overrides:

validateData in class StoredObject

Parameters:

tm - Current transaction manager.

Throws:

Exception - If data is invalid.

getDataClass

public final Class<? extends StoredObject> getDataClass()

getLogicClass

public final Class<? extends Executable> getLogicClass()

getFor

public static PrintLogicDefinition getFor(Class<? extends StoredObject> dataCass,
 String label)

listFor

public static ObjectIterator<PrintLogicDefinition> listFor(Class<? extends StoredObject> dataCass,
 String applicableDataLogicName)

listFor

public static ObjectIterator<PrintLogicDefinition> listFor(Class<? extends StoredObject> dataCass,
 boolean includeSpecial)