Package com.storedobject.core

Class UIFieldMetadata

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.UIFieldMetadata

All Implemented Interfaces:

Displayable, StringFiller, Detail, HasId

public class UIFieldMetadata
extends StoredObject
implements Detail

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
UIFieldMetadata()
UIFieldMetadata(String fieldName, Method getMethod)

Method Summary

Modifier and Type	Method	Description
static String	browseOrder()
static void	columns(Columns columns)
String	getCaption()
int	getColumnSpan()
String	getDisplayName()
boolean	getEditability()
String	getFieldName()
int	getFieldOrder()
int	getIntParameter(int defaultValue, int index)
Column	getMetadata()
String	getParameter(int index)
String	getParameter(String defaultValue, int index)
int	getParameterAsActions(int defaultValue, boolean developer)
Class<? extends StoredObject>	getParameterAsClass(Class<? extends StoredObject> defaultClass)
String	getParameters()
String	getStyle()
String	getTabName()
int	getType()
String	getTypeValue()
static String	getTypeValue(int value)
static String[]	getTypeValues()
MeasurementUnit	getUnit(Class<? extends Quantity> quantityClass)
boolean	getVisibility()
int	getWidth()
boolean	isAddAllowed()
boolean	isAddress()
boolean	isAny()
boolean	isCode()
boolean	isCountry()
boolean	isCurrency()
boolean	isDays()
boolean	isDetailOf(Class<? extends StoredObject> masterClass)	Check if the given class is a "master" for this class.
boolean	isEmail()
boolean	isFieldOrderBuiltIn()
boolean	isMinutes()
boolean	isMultiline()
boolean	isNegativeAllowed()
boolean	isPhone()
boolean	isPopupText()
boolean	isRequired()
boolean	isSecret()
boolean	isSerial()
boolean	isSetAllowed()
boolean	isStyle(String style)
boolean	isTextSearch()
boolean	isTimeZone()
void	saved()	This method is invoked whenever an instance is saved/deleted/resurrected.
void	setCaption(String caption)
void	setDisplayName(String displayName)
void	setEditability(boolean editability)
void	setFieldName(String fieldName)
void	setFieldOrder(int fieldOrder)
void	setGetMethod(Method getMethod)
void	setParameters(String parameters)
void	setSetAllowed(boolean setAllowed)
void	setType(int type)
void	setVisibility(boolean visibility)
void	setWidth(int width)
String	toDisplay()	Display representation of the instance used for human-friendly display.
String	toString()	String representation of the instance.
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, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, 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

Methods inherited from interface com.storedobject.core.Detail

copyValuesFrom, getId, getUniqueId, getUniqueValue

Constructor Details

UIFieldMetadata

public UIFieldMetadata()

UIFieldMetadata

public UIFieldMetadata(String fieldName,
 Method getMethod)

Method Details

columns

public static void columns(Columns columns)

browseOrder

public static String browseOrder()

setGetMethod

public void setGetMethod(Method getMethod)

getMetadata

public Column getMetadata()

isFieldOrderBuiltIn

public boolean isFieldOrderBuiltIn()

toString

public String toString()

Description copied from class: StoredObject

String representation of the instance. Mostly used for logging purposes.

Overrides:

toString in class StoredObject

Returns:

String representation of the instance.

toDisplay

public String toDisplay()

Description copied from class: StoredObject

Display representation of the instance used for human-friendly display.

Specified by:

toDisplay in interface Displayable

Overrides:

toDisplay in class StoredObject

Returns:

Display representation of the instance.

setFieldName

public void setFieldName(String fieldName)

getFieldName

public String getFieldName()

setCaption

public void setCaption(String caption)

getCaption

@Column(required=false)
public String getCaption()

setFieldOrder

public void setFieldOrder(int fieldOrder)

getFieldOrder

@Column(required=false)
public int getFieldOrder()

setType

public void setType(int type)

getType

public int getType()

getTypeValues

public static String[] getTypeValues()

getTypeValue

public static String getTypeValue(int value)

getTypeValue

public String getTypeValue()

setParameters

public void setParameters(String parameters)

getParameters

@Column(required=false)
public String getParameters()

setEditability

public void setEditability(boolean editability)

getEditability

public boolean getEditability()

setVisibility

public void setVisibility(boolean visibility)

getVisibility

public boolean getVisibility()

setWidth

public void setWidth(int width)

getWidth

@Column(required=false)
public int getWidth()

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.

saved

public void saved()

Description copied from class: StoredObject

This method is invoked whenever an instance is saved/deleted/resurrected. It can be overridden to take care of any additional actions required by the application.

Overrides:

saved in class StoredObject

isDetailOf

public boolean isDetailOf(Class<? extends StoredObject> masterClass)

Description copied from interface: Detail

Check if the given class is a "master" for this class. (Must return a consistent value).

Specified by:

isDetailOf in interface Detail

Parameters:

masterClass - Class to check.

Returns:

True if it is a "master" to this detail class. Otherwise, false.

getParameterAsActions

public int getParameterAsActions(int defaultValue,
 boolean developer)

getParameterAsClass

public Class<? extends StoredObject> getParameterAsClass(Class<? extends StoredObject> defaultClass)

getIntParameter

public int getIntParameter(int defaultValue,
 int index)

getUnit

public MeasurementUnit getUnit(Class<? extends Quantity> quantityClass)

getParameter

public String getParameter(int index)

getParameter

public String getParameter(String defaultValue,
 int index)

setSetAllowed

public void setSetAllowed(boolean setAllowed)

isSetAllowed

public boolean isSetAllowed()

isMultiline

public boolean isMultiline()

getColumnSpan

public int getColumnSpan()

isAddAllowed

public boolean isAddAllowed()

isAny

public boolean isAny()

isTextSearch

public boolean isTextSearch()

isMinutes

public boolean isMinutes()

isPopupText

public boolean isPopupText()

isCurrency

public boolean isCurrency()

isCountry

public boolean isCountry()

isPhone

public boolean isPhone()

isEmail

public boolean isEmail()

isAddress

public boolean isAddress()

isTimeZone

public boolean isTimeZone()

isDays

public boolean isDays()

isSerial

public boolean isSerial()

isSecret

public boolean isSecret()

isRequired

public boolean isRequired()

isCode

public boolean isCode()

isNegativeAllowed

public boolean isNegativeAllowed()

getStyle

public String getStyle()

isStyle

public boolean isStyle(String style)

getDisplayName

public String getDisplayName()

setDisplayName

public void setDisplayName(String displayName)

getTabName

public String getTabName()