Package com.storedobject.core

Class TaxCode

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.TaxCode

All Implemented Interfaces:

Displayable, StringFiller, HasId

public class TaxCode
extends StoredObject

Tax code and region of the SystemEntity. For other entities, tax codes and regions must be specified in the respective AccountEntity class.

Author:

Syam

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
TaxCode()	Default constructor for the TaxCode class.

Method Summary

Modifier and Type	Method	Description
static void	columns(Columns columns)	Configures the specified Columns object by adding predefined column names and types.
static TaxCode	getFor(SystemEntity systemEntity)	Retrieves the TaxCode associated with the specified SystemEntity.
SystemEntity	getOrganization()	Retrieves the SystemEntity instance associated with the organization.
Id	getOrganizationId()	Retrieves the unique identifier of the organization.
String	getTaxCode()	Retrieves the tax code associated with this entity.
TaxRegion	getTaxRegion()	Retrieves the TaxRegion associated with the current instance.
Id	getTaxRegionId()	Retrieves the tax region identifier.
static int	hints()	Provides hints for the associated object, combining predefined constants to denote object characteristics such as "small" or "small list".
static void	indices(Indices indices)	Configures the specified Indices object by adding a predefined index for "Organization".
void	saved()	This method is invoked whenever an instance is saved/deleted/resurrected.
void	setOrganization(Id organizationId)	Sets the organization for this TaxCode.
void	setOrganization(SystemEntity organization)	Sets the organization associated with this TaxCode using a SystemEntity.
void	setOrganization(BigDecimal idValue)	Sets the organization associated with this instance using the provided BigDecimal identifier.
void	setTaxCode(String taxCode)	Sets the tax code for the entity.
void	setTaxRegion(Id taxRegionId)	Sets the tax region associated with this object.
void	setTaxRegion(TaxRegion taxRegion)	Sets the tax region by assigning the corresponding region ID.
void	setTaxRegion(BigDecimal idValue)	Sets the tax region using the provided identifier value.
void	validateData(TransactionManager tm)	Validates the data consistency and integrity for the current instance.

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, 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

TaxCode

public TaxCode()

Default constructor for the TaxCode class. Initializes a new instance of the TaxCode object with no parameters.

Method Details

columns

public static void columns(Columns columns)

Configures the specified Columns object by adding predefined column names and types.

Parameters:

columns - the Columns object to configure by adding column definitions

indices

public static void indices(Indices indices)

Configures the specified Indices object by adding a predefined index for "Organization". The index is marked as unique.

Parameters:

indices - the Indices object to configure by adding the "Organization" index

hints

public static int hints()

Provides hints for the associated object, combining predefined constants to denote object characteristics such as "small" or "small list".

Returns:

A bitwise combination of object hints, specifically `ObjectHint.SMALL` and `ObjectHint.SMALL_LIST`.

setOrganization

public void setOrganization(Id organizationId)

Sets the organization for this TaxCode. This method validates the input and throws an exception if the operation is not allowed when the object is not in a loading state and the specified organization ID differs from the current one.

Parameters:

organizationId - the ID of the organization to be associated with this TaxCode

Throws:

Set_Not_Allowed - if the object is not in a loading state, and an attempt is made to change the organization

setOrganization

public void setOrganization(BigDecimal idValue)

Sets the organization associated with this instance using the provided BigDecimal identifier. This method internally converts the BigDecimal value into an Id object and delegates to setOrganization(Id).

Parameters:

idValue - the identifier of the organization as a BigDecimal value to assign to this instance

setOrganization

public void setOrganization(SystemEntity organization)

Sets the organization associated with this TaxCode using a SystemEntity. If the provided SystemEntity is null, the organization will be cleared.

Parameters:

organization - the SystemEntity representing the organization to set, or null to clear the organization.

getOrganizationId

@SetNotAllowed
@Column(order=100)
public Id getOrganizationId()

Retrieves the unique identifier of the organization.

Returns:

the unique identifier of the organization as an Id.

getOrganization

public SystemEntity getOrganization()

Retrieves the SystemEntity instance associated with the organization.

Returns:

the related organization as a SystemEntity instance, or null if no organization is associated.

setTaxCode

public void setTaxCode(String taxCode)

Sets the tax code for the entity.

Parameters:

taxCode - the tax code to be assigned to the entity

getTaxCode

@Column(required=false,
        order=200,
        style="(code)")
public String getTaxCode()

Retrieves the tax code associated with this entity.

Returns:

The tax code as a string. Returns null if no tax code is set.

setTaxRegion

public void setTaxRegion(Id taxRegionId)

Sets the tax region associated with this object.

Parameters:

taxRegionId - the identifier of the tax region to be set

setTaxRegion

public void setTaxRegion(BigDecimal idValue)

Sets the tax region using the provided identifier value.

Parameters:

idValue - the identifier value for the tax region

setTaxRegion

public void setTaxRegion(TaxRegion taxRegion)

Sets the tax region by assigning the corresponding region ID. If the provided TaxRegion object is null, the region ID is set to null.

Parameters:

taxRegion - the TaxRegion object representing the tax region to be set

getTaxRegionId

@Column(order=300)
public Id getTaxRegionId()

Retrieves the tax region identifier.

Returns:

the unique identifier associated with the tax region.

getTaxRegion

public TaxRegion getTaxRegion()

Retrieves the TaxRegion associated with the current instance.

Returns:

the TaxRegion object corresponding to the provided taxRegionId.

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Validates the data consistency and integrity for the current instance. This method ensures that the organizationId and taxRegionId are properly typed and associated with their respective system entities.

Overrides:

validateData in class StoredObject

Parameters:

tm - the transaction manager used to validate and check entity types

Throws:

Exception - if validation fails or any errors occur during the process

saved

public void saved()
           throws Exception

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

Throws:

Exception - When error occurs or invalidate state exists so that transaction will be abandoned.

getFor

public static TaxCode getFor(SystemEntity systemEntity)

Retrieves the TaxCode associated with the specified SystemEntity.

Parameters:

systemEntity - the SystemEntity for which the corresponding TaxCode is to be retrieved

Returns:

the TaxCode associated with the provided SystemEntity