Package com.storedobject.core

Class SystemEntity

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.SystemEntity

All Implemented Interfaces:

Displayable, StringFiller, HasId, HasName, RequiresApproval

public final class SystemEntity
extends StoredObject
implements RequiresApproval, HasName

This class represents an entity whose accounting system exists in this server.

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
SystemEntity()	Constructor for internal use only
SystemEntity(Id entityId, String currency, Date workingDate)	Construct a System Entity

Method Summary

Modifier and Type	Method	Description
static String[]	browseColumns()
static void	columns(Columns columns)
<D extends Date> D	date(D dateGMT)	Convert a date/date-time value from GMT to local.
<D extends Date> D	dateGMT(D date)	Convert a date/date-time value from local to GMT.
static String[]	displayColumns()
static SystemEntity	get()	Get the default System Entity.
static SystemEntity	get(Entity entity)
static SystemEntity	get(String name)
Locale	getAlternateLocale()
String	getAlternateLocaleCountry()
String	getAlternateLocaleLanguage()
boolean	getApprovalsEnabled()
static SystemEntity	getCached(Id id)
String	getCurrency()	Gets the currency.
static Currency	getDefaultCurrency()	Get the default currency.
Date	getEndOfFinancialYear()	Get the ending date of the financial year
Date	getEndOfFinancialYear(Date today)	Get the ending date of the financial year for the given date
Entity	getEntity()	Gets the entity of this System Entity
Id	getEntityId()	Gets the Id of the entity.
String	getLocation()	Gets the location of the Entity.
String	getLogoName()
String	getName()	Gets the name of the Entity
Date	getStartOfFinancialYear()	Get the starting date of the financial year
Date	getStartOfFinancialYear(Date today)	Get the starting date of the financial year for the given date.
int	getStatus()
int	getTimeDifference()	Get the time difference in minutes.
String	getTimeZone()
String	getUniqueCondition()	Gets the unique index condition of this object.
Date	getWorkingDate()	Get the working date
static int	hints()
static void	indices(Indices indices)
static String[]	links()
static ObjectIterator<SystemEntity>	list(String name)
<D extends Date, P extends AbstractPeriod<D>> P	period(P periodGMT)	Convert a period value from GMT to local.
<D extends Date, P extends AbstractPeriod<D>> P	periodGMT(P period)	Convert a period value from local to GMT.
static String[]	protectedColumns()
void	setAlternateLocale(Locale locale)
void	setAlternateLocaleCountry(String alternateLocaleCountry)
void	setAlternateLocaleLanguage(String alternateLocaleLanguage)
void	setApprovalsEnabled(boolean approvalsEnabled)
void	setCurrency(String currency)	Sets the currency.
void	setEntity(Entity entity)	Sets the entity of this System Entity.
void	setEntity(Id id)	Sets the entity of this System Entity.
void	setEntity(BigDecimal idValue)	Sets the entity of this System Entity.
void	setLogoName(String logoName)
void	setStartOfFinancialYear(Date startDate)	Set the start of financial year
void	setStatus(int status)
void	setTimeZone(String timeZone)
void	setWorkingDate(Date workingDate)	Set the working date
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, 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, 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

SystemEntity

public SystemEntity(Id entityId,
 String currency,
 Date workingDate)

Construct a System Entity

Parameters:

entityId - The Id of the legal business entity of this System Entity.

currency - The accounting currency.

workingDate - Working date

SystemEntity

public SystemEntity()

Constructor for internal use only

Method Details

columns

public static void columns(Columns columns)

indices

public static void indices(Indices indices)

getUniqueCondition

public String getUniqueCondition()

Description copied from class: StoredObject

Gets the unique index condition of this object.

Overrides:

getUniqueCondition in class StoredObject

Returns:

Unique index condition.

displayColumns

public static String[] displayColumns()

browseColumns

public static String[] browseColumns()

links

public static String[] links()

hints

public static int hints()

protectedColumns

public static String[] protectedColumns()

getApprovalsEnabled

@SetNotAllowed
public boolean getApprovalsEnabled()

setApprovalsEnabled

public void setApprovalsEnabled(boolean approvalsEnabled)

getName

public String getName()

Gets the name of the Entity

Specified by:

getName in interface HasName

Returns:

The name

getLocation

public String getLocation()

Gets the location of the Entity.

Returns:

The location. Each line of the location is delimited by a semicolon.

getCurrency

@SetNotAllowed
@Column(style="(currency)")
public String getCurrency()

Gets the currency.

Returns:

The currency

setCurrency

public void setCurrency(String currency)

Sets the currency.

Parameters:

currency - The new currency.

getEntityId

@SetNotAllowed
public Id getEntityId()

Gets the Id of the entity.

Returns:

The Id of the entity

setEntity

public void setEntity(BigDecimal idValue)

Sets the entity of this System Entity.

Parameters:

idValue - The new entity Id.

setEntity

public void setEntity(Entity entity)

Sets the entity of this System Entity.

Parameters:

entity - Entity.

setEntity

public void setEntity(Id id)

Sets the entity of this System Entity.

Parameters:

id - The new entity Id.

getEntity

public Entity getEntity()

Gets the entity of this System Entity

Returns:

The entity of this System Entity

getStatus

@SetNotAllowed
public int getStatus()

setStatus

public void setStatus(int status)

getTimeZone

@Column(style="(timezone)")
public String getTimeZone()

setTimeZone

public void setTimeZone(String timeZone)

setWorkingDate

public void setWorkingDate(Date workingDate)

Set the working date

Parameters:

workingDate - Working date to be set

getWorkingDate

public Date getWorkingDate()

Get the working date

Returns:

Working date

setStartOfFinancialYear

public void setStartOfFinancialYear(Date startDate)

Set the start of financial year

Parameters:

startDate - Starting date of the financial year

getStartOfFinancialYear

public Date getStartOfFinancialYear()

Get the starting date of the financial year

Returns:

Start date of the financial year

getStartOfFinancialYear

public Date getStartOfFinancialYear(Date today)

Get the starting date of the financial year for the given date.

Parameters:

today - Today

Returns:

Start date of the financial year

getEndOfFinancialYear

public Date getEndOfFinancialYear()

Get the ending date of the financial year

Returns:

End date of the financial year

getEndOfFinancialYear

public Date getEndOfFinancialYear(Date today)

Get the ending date of the financial year for the given date

Parameters:

today - Today

Returns:

End date of the financial year

setLogoName

public void setLogoName(String logoName)

getLogoName

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

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.

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.

get

public static SystemEntity get(Entity entity)

getAlternateLocaleLanguage

@Column(required=false,
        style="(lower)")
public String getAlternateLocaleLanguage()

setAlternateLocaleLanguage

public void setAlternateLocaleLanguage(String alternateLocaleLanguage)

getAlternateLocaleCountry

@Column(required=false,
        style="(country)")
public String getAlternateLocaleCountry()

setAlternateLocaleCountry

public void setAlternateLocaleCountry(String alternateLocaleCountry)

getAlternateLocale

public Locale getAlternateLocale()

setAlternateLocale

public void setAlternateLocale(Locale locale)

get

public static SystemEntity get()

Get the default System Entity. If more than one entity are configured, "null" will be returned.

Returns:

Default System Entity.

getDefaultCurrency

public static Currency getDefaultCurrency()

Get the default currency. If more than one entity are configured with different accounting currencies, "null" will be returned.

Returns:

Default System Entity.

get

public static SystemEntity get(String name)

list

public static ObjectIterator<SystemEntity> list(String name)

dateGMT

public <D extends Date> D dateGMT(D date)

Convert a date/date-time value from local to GMT.

Type Parameters:

D - Date/date-time type.

Parameters:

date - Local value.

Returns:

GMT value.

date

public <D extends Date> D date(D dateGMT)

Convert a date/date-time value from GMT to local.

Type Parameters:

D - Date/date-time type.

Parameters:

dateGMT - GMT value.

Returns:

Local value.

periodGMT

public <D extends Date,
P extends AbstractPeriod<D>>
P periodGMT(P period)

Convert a period value from local to GMT.

Type Parameters:

D - Date/date-time type.

P - Period type.

Parameters:

period - Local value.

Returns:

GMT value.

period

public <D extends Date,
P extends AbstractPeriod<D>>
P period(P periodGMT)

Convert a period value from GMT to local.

Type Parameters:

D - Date/date-time type.

P - Period type.

Parameters:

periodGMT - Local value.

Returns:

Local value.

getTimeDifference

public int getTimeDifference()

Get the time difference in minutes.

Returns:

Time difference.

getCached

public static SystemEntity getCached(Id id)