Package com.storedobject.core

Class Logic

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.Logic

All Implemented Interfaces:

Displayable, StringFiller, DisplayOrder, HasId, RequiresApproval, Comparable<DisplayOrder>

public final class Logic
extends StoredObject
implements DisplayOrder, RequiresApproval

Used for defining a menu option. (Menus can be grouped using LogicGroup).

Author:

Syam

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
Logic()	Constructor for internal use only
Logic(String className, String title)	Constructs a Logic

Method Summary

Modifier and Type	Method	Description
static String[]	browseColumns()
static void	columns(Columns columns)
static Logic	get(String title)
int	getApprovalCount()
boolean	getAutoExecute()
String	getClassName()	Gets the class name of the Logic
int	getDevice()
static String[]	getDeviceBitValues()
String	getDeviceValue()
static String	getDeviceValue(int value)
int	getDisplayOrder()
Executable	getExecutable()
String	getIconImageName()
int	getMaximumDeviceHeight()
int	getMaximumDeviceWidth()
int	getMinimumDeviceHeight()
int	getMinimumDeviceWidth()
Class<? extends StoredObject>	getObjectClass()
static Logic	getRunningLogic(Device device)
static String	getRunningLogicTitle(Device device, String defaultTitle)
boolean	getSingleInstance()
String	getTitle()	Gets the title of the Logic.
static void	indices(Indices indices)
boolean	isApplicableTo(String deviceName)
static String[]	links()
static ObjectIterator<Logic>	list(String title)
static String[]	searchColumns()
void	setApprovalCount(int approvalCount)
void	setAutoExecute(boolean autoExecute)
void	setClassName(String className)	Sets the class name of the Logic.
void	setDevice(int device)
void	setDisplayOrder(int displayOrder)
void	setExecutable(Executable executable)
void	setIconImageName(String iconImageName)
void	setMaximumDeviceHeight(int maximumDeviceHeight)
void	setMaximumDeviceWidth(int maximumDeviceWidth)
void	setMinimumDeviceHeight(int minimumDeviceHeight)
void	setMinimumDeviceWidth(int minimumDeviceWidth)
void	setSingleInstance(boolean singleInstance)
void	setTitle(String title)	Sets the title of the Logic.
String	toString()	String representation of the instance.
void	validateData(TransactionManager tm)	The system will invoke this whenever the object is saved to the DB.
void	validateDelete()	This method will be invoked whenever an existing instance is deleted from the database.

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, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getActor, getAttachment, getAttachmentId, getChildren, getContemporaryOf, 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, listDeletedIds, 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, loadAttributesFrom, 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, save, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, transacting, undelete, undelete, undeleted, updated, user, userId, validate, validateChildAttach, validateChildDetach, validateChildUpdate, 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.DisplayOrder

compareTo, getDisplayOrderGap

Constructor Details

Logic

public Logic(String className,
 String title)

Constructs a Logic

Parameters:

className - Fully qualified class name of the Logic.

title - Title of the Logic (human readable form).

Logic

public Logic()

Constructor for internal use only

Method Details

columns

public static void columns(Columns columns)

indices

public static void indices(Indices indices)

links

public static String[] links()

browseColumns

public static String[] browseColumns()

searchColumns

public static String[] searchColumns()

getObjectClass

public Class<? extends StoredObject> getObjectClass()

getApprovalCount

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

setApprovalCount

public void setApprovalCount(int approvalCount)

getClassName

public String getClassName()

Gets the class name of the Logic

Returns:

The class name

setClassName

public void setClassName(String className)

Sets the class name of the Logic.

Parameters:

className - The class name.

getTitle

@Column(caption="Menu Label")
public String getTitle()

Gets the title of the Logic.

Specified by:

getTitle in interface DisplayOrder

Returns:

The title.

setTitle

public void setTitle(String title)

Sets the title of the Logic.

Specified by:

setTitle in interface DisplayOrder

Parameters:

title - The new title.

setIconImageName

public void setIconImageName(String iconImageName)

getIconImageName

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

setAutoExecute

public void setAutoExecute(boolean autoExecute)

getAutoExecute

public boolean getAutoExecute()

getSingleInstance

public boolean getSingleInstance()

setSingleInstance

public void setSingleInstance(boolean singleInstance)

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Description copied from class: StoredObject

The system will invoke this whenever the object is saved to the DB. It will be invoked in all cases while creating new objects and updating/deleting/undeleting 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.

validateDelete

public void validateDelete()
                    throws Exception

Description copied from class: StoredObject

This method will be invoked whenever an existing instance is deleted from the database. So, it will be called within an active transaction. Child classes can override this method to do validation when an existing instance is deleted from the database.

Note: When overridden "super" should be called, otherwise, a "design error" will occur.

Also, see StoredObject.validate().

Overrides:

validateDelete in class StoredObject

Throws:

Exception - By raising an exception from this method, the current transaction can be abandoned.

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.

setDisplayOrder

public void setDisplayOrder(int displayOrder)

Specified by:

setDisplayOrder in interface DisplayOrder

getDisplayOrder

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

Specified by:

getDisplayOrder in interface DisplayOrder

setDevice

public void setDevice(int device)

getDevice

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

getDeviceBitValues

public static String[] getDeviceBitValues()

getDeviceValue

public static String getDeviceValue(int value)

getDeviceValue

public String getDeviceValue()

setMinimumDeviceHeight

public void setMinimumDeviceHeight(int minimumDeviceHeight)

getMinimumDeviceHeight

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

setMaximumDeviceHeight

public void setMaximumDeviceHeight(int maximumDeviceHeight)

getMaximumDeviceHeight

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

setMinimumDeviceWidth

public void setMinimumDeviceWidth(int minimumDeviceWidth)

getMinimumDeviceWidth

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

setMaximumDeviceWidth

public void setMaximumDeviceWidth(int maximumDeviceWidth)

getMaximumDeviceWidth

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

get

public static Logic get(String title)

list

public static ObjectIterator<Logic> list(String title)

getExecutable

public Executable getExecutable()

setExecutable

public void setExecutable(Executable executable)

getRunningLogic

public static Logic getRunningLogic(Device device)

getRunningLogicTitle

public static String getRunningLogicTitle(Device device,
 String defaultTitle)

isApplicableTo

public boolean isApplicableTo(String deviceName)