Package com.storedobject.job

Class MessageGroup

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.job.MessageGroup

All Implemented Interfaces:

Displayable, StringFiller, HasId, RequiresApproval

public final class MessageGroup
extends StoredObject
implements RequiresApproval

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MessageGroup.NOT_FOUND

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
MessageGroup()

Method Summary

Modifier and Type	Method	Description
static void	columns(Columns columns)
static MessageGroup	create(String name, TransactionManager tm)	Create a new message group if it doesn't exist.
static MessageGroup	get(String name)
static MessageGroup	getFor(String name)
String	getName()
MessageTemplate	getTemplate()
Id	getTemplateId()
String	getUniqueCondition()	Gets the unique index condition of this object.
static int	hints()
static void	indices(Indices indices)
static String[]	links()
static ObjectIterator<MessageGroup>	list(String name)
<P extends PersonRole> List<Contact>	listContacts(int contactType)	Get the list of contacts belonging to this message group.
ObjectIterator<Person>	listMembers()
List<SystemUser>	listUsers()
static boolean	notify(String groupName, TransactionManager tm, Object... messageParameters)	Create and send a message to all members of this group.
void	send(Person person, TransactionControl tc, Object... messageParameters)	Create and send a message to all members of this group and to an additional person.
void	send(Person person, TransactionManager tm, Object... messageParameters)	Create and send a message to all members of this group and to an additional person.
void	send(TransactionControl tc, Object... messageParameters)	Create and send a message to all members of this group.
void	send(TransactionManager tm, Object... messageParameters)	Create and send a message to all members of this group.
static void	send(String groupName, Person person, TransactionControl tc, Object... messageParameters)	Create and send a message to all members of this group and to an additional person.
static void	send(String groupName, Person person, TransactionManager tm, Object... messageParameters)	Create and send a message to all members of this group and to an additional person.
static void	send(String groupName, TransactionControl tc, Object... messageParameters)	Create and send a message to all members of this group.
static void	send(String groupName, TransactionManager tm, Object... messageParameters)	Create and send a message to all members of this group.
void	setName(String name)
void	setTemplate(Id templateId)
void	setTemplate(MessageTemplate template)
void	setTemplate(BigDecimal idValue)
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

MessageGroup

public MessageGroup()

Method Details

columns

public static void columns(Columns columns)

hints

public static int hints()

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.

getFor

public static MessageGroup getFor(String name)

get

public static MessageGroup get(String name)

list

public static ObjectIterator<MessageGroup> list(String name)

links

public static String[] links()

setName

public void setName(String name)

getName

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

setTemplate

public void setTemplate(Id templateId)

setTemplate

public void setTemplate(BigDecimal idValue)

setTemplate

public void setTemplate(MessageTemplate template)

getTemplateId

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

getTemplate

public MessageTemplate getTemplate()

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.

create

public static MessageGroup create(String name,
 TransactionManager tm)

Create a new message group if it doesn't exist.

Parameters:

name - Name of the group.

tm - Transaction manager.

Returns:

Message group instance.

listMembers

public ObjectIterator<Person> listMembers()

listContacts

public <P extends PersonRole> List<Contact> listContacts(int contactType)

Get the list of contacts belonging to this message group.

Type Parameters:

P - Contact role type.

Parameters:

contactType - Type of contact (0: SMS, 1: Email, 2: Application)

Returns:

List.

listUsers

public List<SystemUser> listUsers()

send

public void send(TransactionManager tm,
 Object... messageParameters)
          throws Throwable

Create and send a message to all members of this group.

Parameters:

tm - Transaction Manager.

messageParameters - Parameters for creating a message from the associated template.

Throws:

Throwable - If a message cannot be created.

send

public void send(Person person,
 TransactionManager tm,
 Object... messageParameters)
          throws Throwable

Create and send a message to all members of this group and to an additional person.

Parameters:

person - Additional person to receive the message

tm - Transaction Manager.

messageParameters - Parameters for creating a message from the associated template.

Throws:

Throwable - If a message cannot be created.

send

public void send(TransactionControl tc,
 Object... messageParameters)
          throws Throwable

Create and send a message to all members of this group.

Parameters:

tc - Transaction Control.

messageParameters - Parameters for creating a message from the associated template.

Throws:

Throwable - If a message cannot be created.

send

public void send(Person person,
 TransactionControl tc,
 Object... messageParameters)
          throws Throwable

Create and send a message to all members of this group and to an additional person.

Parameters:

person - Additional person to receive the message

tc - Transaction Control.

messageParameters - Parameters for creating a message from the associated template.

Throws:

Throwable - If a message cannot be created.

send

public static void send(String groupName,
 TransactionManager tm,
 Object... messageParameters)
                 throws Throwable

Create and send a message to all members of this group. No message will be sent if the message group does not exist.

Parameters:

groupName - Name of the message group.

tm - Transaction Manager.

messageParameters - Parameters for creating a message from the associated template.

Throws:

Throwable - If a message cannot be created.

send

public static void send(String groupName,
 TransactionControl tc,
 Object... messageParameters)
                 throws Throwable

Create and send a message to all members of this group. No message will be sent if the message group does not exist.

Parameters:

groupName - Name of the message group.

tc - Transaction Control.

messageParameters - Parameters for creating a message from the associated template.

Throws:

Throwable - If a message cannot be created.

send

public static void send(String groupName,
 Person person,
 TransactionManager tm,
 Object... messageParameters)
                 throws Throwable

Create and send a message to all members of this group and to an additional person. No message will be sent if the message group does not exist.

Parameters:

groupName - Name of the message group.

person - Additional person to receive the message

tm - Transaction Manager.

messageParameters - Parameters for creating a message from the associated template.

Throws:

Throwable - If a message cannot be created.

send

public static void send(String groupName,
 Person person,
 TransactionControl tc,
 Object... messageParameters)
                 throws Throwable

Create and send a message to all members of this group and to an additional person. No message will be sent if the message group does not exist.

Parameters:

groupName - Name of the message group.

person - Additional person to receive the message (Could be null).

tc - Transaction Control.

messageParameters - Parameters for creating a message from the associated template.

Throws:

Throwable - If a message cannot be created.

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.

notify

public static boolean notify(String groupName,
 TransactionManager tm,
 Object... messageParameters)

Create and send a message to all members of this group.

Note: If the message group does not exist, a new one will be created.

Parameters:

groupName - Name of the message group.

tm - Transaction manager.

messageParameters - Parameters for creating a message from the associated template.

Returns:

True if the message is successfully created for delivery.