Package com.storedobject.core

Class EntityRole

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.EntityRole

All Implemented Interfaces:

Displayable, StringFiller, HasContacts, HasId, HasName, OfEntity

Direct Known Subclasses:

Organization

public abstract class EntityRole
extends StoredObject
implements OfEntity, HasContacts, HasName

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
EntityRole()

Method Summary

Modifier and Type	Method	Description
static void	columns(Columns columns)
static String[]	displayColumns()
static <T extends EntityRole> T	get(SystemEntity systemEntity, Class<T> roleClass, Entity entity)
static <T extends EntityRole> T	get(SystemEntity systemEntity, Class<T> roleClass, Entity entity, boolean any)
static <T extends EntityRole> T	getByEntityId(SystemEntity systemEntity, Class<T> roleClass, Id entityId)
static <T extends EntityRole> T	getByEntityId(SystemEntity systemEntity, Class<T> roleClass, Id entityId, boolean any)
static <T extends EntityRole> T	getByName(SystemEntity systemEntity, Class<T> roleClass, String name)
static <T extends EntityRole> T	getByName(SystemEntity systemEntity, Class<T> roleClass, String name, boolean any)
Id	getContactOwnerId()	Get the Id of the object that owns the contact.
Entity	getEntity()	Same as getOrganization().
Id	getEntityId()	Same as getOrganizationId().
String	getName()	Name of the contact.
Entity	getOrganization()
Id	getOrganizationId()
SystemEntity	getSystemEntity()
Id	getSystemEntityId()
String	getUniqueCondition()	Gets the unique index condition of this object.
static void	indices(Indices indices)
boolean	isActive()	Check if this role is currently active or not.
static <T extends EntityRole> ObjectIterator<T>	listByName(SystemEntity systemEntity, Class<T> roleClass, String name)
static <T extends EntityRole> ObjectIterator<T>	listByName(SystemEntity systemEntity, Class<T> roleClass, String name, boolean any)
static String[]	searchColumns()
void	setEntity(Entity organization)	Same as setOrganization(Entity).
void	setEntity(Id organizationId)	Same as setOrganization(Id).
void	setOrganization(Entity organization)
void	setOrganization(Id organizationId)
void	setOrganization(BigDecimal idValue)
void	setSystemEntity(Id systemEntityId)
void	setSystemEntity(SystemEntity systemEntity)
void	setSystemEntity(BigDecimal idValue)
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

Methods inherited from interface com.storedobject.core.HasContacts

getAddress, getAddress, getContact, getContact, getContactGroupingCode, getContactObject, getContactObject, getContactObject, getContactRaw, getContactRaw, getEmail, getEmail, getId, getMobile, getPhone, getPhone, getTelegram, listContacts, listContactTypes, setContact, setContact

Methods inherited from interface com.storedobject.core.OfEntity

check, findSystemEntityId

Constructor Details

EntityRole

public EntityRole()

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()

searchColumns

public static String[] searchColumns()

setOrganization

public void setOrganization(Id organizationId)

setOrganization

public void setOrganization(BigDecimal idValue)

setOrganization

public void setOrganization(Entity organization)

getOrganizationId

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

getOrganization

public Entity getOrganization()

setSystemEntity

public void setSystemEntity(Id systemEntityId)

Specified by:

setSystemEntity in interface OfEntity

setSystemEntity

public void setSystemEntity(BigDecimal idValue)

setSystemEntity

public void setSystemEntity(SystemEntity systemEntity)

getSystemEntityId

@SetNotAllowed
@Column(order=100,
        caption="Of")
public Id getSystemEntityId()

Specified by:

getSystemEntityId in interface OfEntity

getSystemEntity

public SystemEntity getSystemEntity()

Specified by:

getSystemEntity in interface OfEntity

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 <T extends EntityRole> T get(SystemEntity systemEntity,
 Class<T> roleClass,
 Entity entity)

get

public static <T extends EntityRole> T get(SystemEntity systemEntity,
 Class<T> roleClass,
 Entity entity,
 boolean any)

getByEntityId

public static <T extends EntityRole> T getByEntityId(SystemEntity systemEntity,
 Class<T> roleClass,
 Id entityId)

getByEntityId

public static <T extends EntityRole> T getByEntityId(SystemEntity systemEntity,
 Class<T> roleClass,
 Id entityId,
 boolean any)

getByName

public static <T extends EntityRole> T getByName(SystemEntity systemEntity,
 Class<T> roleClass,
 String name)

getByName

public static <T extends EntityRole> T getByName(SystemEntity systemEntity,
 Class<T> roleClass,
 String name,
 boolean any)

listByName

public static <T extends EntityRole>
ObjectIterator<T> listByName(SystemEntity systemEntity,
 Class<T> roleClass,
 String name)

listByName

public static <T extends EntityRole>
ObjectIterator<T> listByName(SystemEntity systemEntity,
 Class<T> roleClass,
 String name,
 boolean any)

getContactOwnerId

public Id getContactOwnerId()

Description copied from interface: HasContacts

Get the Id of the object that owns the contact. (It is possible that some other related object may be owing the contact information).

Specified by:

getContactOwnerId in interface HasContacts

Returns:

By default, the same instance of the class owns the contact and thus, it returns StoredObject.getId().

setEntity

public void setEntity(Entity organization)

Same as setOrganization(Entity).

Parameters:

organization - Organization.

setEntity

public void setEntity(Id organizationId)

Same as setOrganization(Id).

Parameters:

organizationId - Id of the organization.

getEntityId

public Id getEntityId()

Same as getOrganizationId().

Returns:

Id of the organization.

getEntity

public Entity getEntity()

Same as getOrganization().

Returns:

The organization.

getName

public String getName()

Description copied from interface: HasContacts

Name of the contact. The default implementation returns null.

Specified by:

getName in interface HasContacts

Specified by:

getName in interface HasName

Returns:

Name of the contact.

isActive

public boolean isActive()

Check if this role is currently active or not.

Returns:

True/false.