Package com.storedobject.core

Class MessageTemplate

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.MessageTemplate

All Implemented Interfaces:

Displayable, StringFiller, HasId

public final class MessageTemplate
extends StoredObject

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
MessageTemplate()

Method Summary

Modifier and Type	Method	Description
static void	columns(Columns columns)
static MessageTemplate	create(String name, TransactionManager tm)	Create a template if it doesn't exist.
String	createEmailAddress(Object... parameters)
StoredObject	createGeneratedBy(Object... parameters)
String	createMessage(Person person, Object... parameters)	Creates a message by replacing placeholders in the template with the provided parameters.
String	createMessage(Object... parameters)	Deprecated. Please use createMessage(Person, Object...) instead.
Class<?>	createProcessorLogic(Object... parameters)
SenderGroup	createSenderGroup(Object... parameters)
String	createSubject(Object... parameters)
int	createValidity(Object... parameters)
static MessageTemplate	get(String code)
String	getCode()
ContactType	getContactType()
Id	getContactTypeId()
int	getDelivery()
String	getDeliveryValue()
static String	getDeliveryValue(int value)
static String[]	getDeliveryValues()
static MessageTemplate	getFor(String code)
String	getTemplate()
String	getUniqueCondition()	Gets the unique index condition of this object.
static void	indices(Indices indices)
static ObjectIterator<MessageTemplate>	list(String code)
List<MessageTemplate>	listAll()
List<MessageTemplate>	listAll(int deliveryType)
static List<MessageTemplate>	listAll(String templateName)
static List<MessageTemplate>	listAll(String templateName, int deliveryType)
static boolean	notify(String templateName, TransactionManager tm, Iterable<Person> persons, Object... messageParameters)	Create and send messages to the given list of persons.
static List<Id>	send(String templateName, TransactionControl tc, Person person, Object... messageParameters)
static List<Id>	send(String templateName, TransactionControl tc, Iterable<Person> persons, Object... messageParameters)
void	setCode(String code)
void	setContactType(ContactType contactType)
void	setContactType(Id contactTypeId)
void	setContactType(BigDecimal idValue)
void	setDelivery(int delivery)
void	setTemplate(String template)
String	toString()	String representation of the instance.
void	validateData(TransactionManager tm)	The system will invoke this 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, 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, 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, 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

MessageTemplate

public MessageTemplate()

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.

setCode

public void setCode(String code)

getCode

@SetNotAllowed
@Column(style="(code)",
        order=1)
public String getCode()

setContactType

public void setContactType(Id contactTypeId)

setContactType

public void setContactType(BigDecimal idValue)

setContactType

public void setContactType(ContactType contactType)

getContactTypeId

@Column(order=2)
public Id getContactTypeId()

getContactType

public ContactType getContactType()

setTemplate

public void setTemplate(String template)

getTemplate

@Column(style="(large)",
        order=3)
public String getTemplate()

setDelivery

public void setDelivery(int delivery)

getDelivery

@Column(order=300)
public int getDelivery()

getDeliveryValues

public static String[] getDeliveryValues()

getDeliveryValue

public static String getDeliveryValue(int value)

getDeliveryValue

public String getDeliveryValue()

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.

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.

getFor

public static MessageTemplate getFor(String code)

get

public static MessageTemplate get(String code)

list

public static ObjectIterator<MessageTemplate> list(String code)

createMessage

@Deprecated
public String createMessage(Object... parameters)

Deprecated.

Please use createMessage(Person, Object...) instead.

Creates a message by replacing placeholders in the template with the provided parameters. Placeholders should be specified in angle-brackets with an ordinal number of the parameter.

Parameters:

parameters - The parameters used to replace placeholders in the template.

Returns:

The generated message after replacing the placeholders with the parameters.

createMessage

public String createMessage(Person person,
 Object... parameters)

Creates a message by replacing placeholders in the template with the provided parameters. Placeholders should be specified in angle-brackets with an ordinal number of the parameter. A special placeholder P in angle-brackets can be used for substituting the person's name and a placeholder TP in angle-brackets can be used for substituting person's name with salutation.

Parameters:

person - The person to whom the message is addressed.

parameters - The parameters used to replace placeholders in the template.

Returns:

The generated message after replacing the placeholders with the parameters.

createSubject

public String createSubject(Object... parameters)

createEmailAddress

public String createEmailAddress(Object... parameters)

createProcessorLogic

public Class<?> createProcessorLogic(Object... parameters)

createGeneratedBy

public StoredObject createGeneratedBy(Object... parameters)

createSenderGroup

public SenderGroup createSenderGroup(Object... parameters)

createValidity

public int createValidity(Object... parameters)

listAll

public List<MessageTemplate> listAll(int deliveryType)

listAll

public List<MessageTemplate> listAll()

listAll

public static List<MessageTemplate> listAll(String templateName)

listAll

public static List<MessageTemplate> listAll(String templateName,
 int deliveryType)

send

public static List<Id> send(String templateName,
 TransactionControl tc,
 Person person,
 Object... messageParameters)
                     throws Throwable

Throws:

Throwable

send

public static List<Id> send(String templateName,
 TransactionControl tc,
 Iterable<Person> persons,
 Object... messageParameters)
                     throws Throwable

Throws:

Throwable

notify

public static boolean notify(String templateName,
 TransactionManager tm,
 Iterable<Person> persons,
 Object... messageParameters)

Create and send messages to the given list of persons.

Note: If the template doesn't exist, a new template is created.

Parameters:

templateName - Template name.

tm - Transaction manager.

persons - List of persons.

messageParameters - Parameters for creating message from the associated template.

Returns:

True if the message is successfully created for delivery.

create

public static MessageTemplate create(String name,
 TransactionManager tm)

Create a template if it doesn't exist.

Parameters:

tm - Transaction manager

Returns:

The template that is created or retrieved.