Package com.storedobject.core

Class LoginMessage

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.LoginMessage

All Implemented Interfaces:

Displayable, StringFiller, HasId

public class LoginMessage
extends StoredObject

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
LoginMessage()

Method Summary

Modifier and Type	Method	Description
static LoginMessage	alert(Transaction transaction, String message, StoredObject person)
static LoginMessage	alert(Transaction transaction, String message, StoredObject person, int validityInDays)
static LoginMessage	alert(Transaction transaction, String message, StoredObject person, StoredObject generatedBy)
static LoginMessage	alert(Transaction transaction, String message, StoredObject person, StoredObject generatedBy, int validityInDays)
static LoginMessage	alert(Transaction transaction, String message, StoredObject person, Class<?> processorClass)
static LoginMessage	alert(Transaction transaction, String message, StoredObject person, Class<?> processorClass, int validityInDays)
static LoginMessage	alert(Transaction transaction, String message, StoredObject person, Class<?> processorClass, StoredObject generatedBy)
static LoginMessage	alert(Transaction transaction, String message, StoredObject person, Class<?> processorClass, StoredObject generatedBy, int validityInDays)
static LoginMessage	alert(Transaction transaction, String message, Iterable<? extends StoredObject> persons)
static LoginMessage	alert(Transaction transaction, String message, Iterable<? extends StoredObject> persons, int validityInDays)
static LoginMessage	alert(Transaction transaction, String message, Iterable<? extends StoredObject> persons, StoredObject generatedBy, int validityInDays)
static LoginMessage	alert(Transaction transaction, String message, Iterable<? extends StoredObject> persons, Class<?> processorClass)
static LoginMessage	alert(Transaction transaction, String message, Iterable<? extends StoredObject> persons, Class<?> processorClass, int validityInDays)
static LoginMessage	alert(Transaction transaction, String message, Iterable<? extends StoredObject> persons, Class<?> processorClass, StoredObject generatedBy)
static LoginMessage	alert(Transaction transaction, String message, Iterable<? extends StoredObject> persons, Class<?> processorClass, StoredObject generatedBy, int validityInDays)
static void	columns(Columns columns)
LoginMessage	escalate(TransactionControl transactionControl, Iterable<? extends StoredObject> persons, int days)
boolean	getActive()
boolean	getDisableLogin()
StoredObject	getGeneratedBy()
boolean	getLoginAlert()
String	getMessage()
int	getPriority()
String	getPriorityValue()
static String	getPriorityValue(int value)
static String[]	getPriorityValues()
Logic	getProcessorLogic()
boolean	getShowEveryTime()
Timestamp	getValidFrom()
Timestamp	getValidTo()
boolean	isReadBy(Id personId)
boolean	isReadBy(Person person)
boolean	isReadBy(PersonRole personRole)
boolean	isReadBy(SystemUser user)
boolean	isSentBy(Id personId)
boolean	isSentBy(Person person)
boolean	isSentBy(PersonRole personRole)
boolean	isSentBy(SystemUser user)
static String[]	links()
ObjectIterator<StoredObject>	listGeneratedBy()
static ObjectIterator<LoginMessage>	listMine(StoredObject generatedBy)
boolean	markAsRead(TransactionManager tm)
boolean	markAsRead(TransactionManager tm, boolean doNotDelete)
void	setActive(boolean active)
void	setDisableLogin(boolean disableLogin)
void	setGeneratedBy(TransactionManager tm, StoredObject generatedBy)
void	setGeneratedBy(Transaction transaction, StoredObject generatedBy)
void	setLoginAlert(boolean loginAlert)
void	setMessage(String message)
void	setPriority(int priority)
void	setProcessorLogic(TransactionManager tm, Class<?> processorClass)
void	setProcessorLogic(Transaction transaction, Class<?> processorClass)
void	setShowEveryTime(boolean showEveryTime)
void	setValidFrom(Timestamp validFrom)
void	setValidTo(Timestamp validTo)
static boolean	showLoginMessages(MessageViewer viewer)
static void	showMessages(ApplicationServer server, Id minId)
void	validateData(TransactionManager tm)	The system will invoke this whenever the object is saved to the DB.
void	validateDelete()	This method will be invoked whenever an existing instance is deleted from the database.

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, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, toString, transacting, undelete, undelete, undeleted, updated, user, userId, validate, validateChildAttach, validateChildDetach, validateChildUpdate, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

LoginMessage

public LoginMessage()

Method Details

columns

public static void columns(Columns columns)

links

public static String[] links()

setMessage

public void setMessage(String message)

getMessage

@Column(style="(large)")
public String getMessage()

setActive

public void setActive(boolean active)

getActive

public boolean getActive()

setValidFrom

public void setValidFrom(Timestamp validFrom)

getValidFrom

public Timestamp getValidFrom()

setValidTo

public void setValidTo(Timestamp validTo)

getValidTo

public Timestamp getValidTo()

setLoginAlert

public void setLoginAlert(boolean loginAlert)

getLoginAlert

public boolean getLoginAlert()

setDisableLogin

public void setDisableLogin(boolean disableLogin)

getDisableLogin

public boolean getDisableLogin()

setShowEveryTime

public void setShowEveryTime(boolean showEveryTime)

getShowEveryTime

public boolean getShowEveryTime()

setPriority

public void setPriority(int priority)

getPriority

public int getPriority()

getPriorityValues

public static String[] getPriorityValues()

getPriorityValue

public static String getPriorityValue(int value)

getPriorityValue

public String getPriorityValue()

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.

setProcessorLogic

public void setProcessorLogic(TransactionManager tm,
 Class<?> processorClass)
                       throws Exception

Throws:

Exception

setProcessorLogic

public void setProcessorLogic(Transaction transaction,
 Class<?> processorClass)
                       throws Exception

Throws:

Exception

getProcessorLogic

public Logic getProcessorLogic()

setGeneratedBy

public void setGeneratedBy(TransactionManager tm,
 StoredObject generatedBy)
                    throws Exception

Throws:

Exception

setGeneratedBy

public void setGeneratedBy(Transaction transaction,
 StoredObject generatedBy)
                    throws Exception

Throws:

Exception

getGeneratedBy

public StoredObject getGeneratedBy()

listGeneratedBy

public ObjectIterator<StoredObject> listGeneratedBy()

listMine

public static ObjectIterator<LoginMessage> listMine(StoredObject generatedBy)

isReadBy

public boolean isReadBy(SystemUser user)

isReadBy

public boolean isReadBy(Person person)

isReadBy

public boolean isReadBy(PersonRole personRole)

isReadBy

public boolean isReadBy(Id personId)

isSentBy

public boolean isSentBy(SystemUser user)

isSentBy

public boolean isSentBy(Person person)

isSentBy

public boolean isSentBy(PersonRole personRole)

isSentBy

public boolean isSentBy(Id personId)

showLoginMessages

public static boolean showLoginMessages(MessageViewer viewer)

showMessages

public static void showMessages(ApplicationServer server,
 Id minId)

alert

public static LoginMessage alert(Transaction transaction,
 String message,
 StoredObject person)
                          throws Exception

Throws:

Exception

alert

public static LoginMessage alert(Transaction transaction,
 String message,
 StoredObject person,
 StoredObject generatedBy)
                          throws Exception

Throws:

Exception

alert

public static LoginMessage alert(Transaction transaction,
 String message,
 StoredObject person,
 Class<?> processorClass)
                          throws Exception

Throws:

Exception

alert

public static LoginMessage alert(Transaction transaction,
 String message,
 StoredObject person,
 Class<?> processorClass,
 StoredObject generatedBy)
                          throws Exception

Throws:

Exception

alert

public static LoginMessage alert(Transaction transaction,
 String message,
 Iterable<? extends StoredObject> persons)
                          throws Exception

Throws:

Exception

alert

public static LoginMessage alert(Transaction transaction,
 String message,
 Iterable<? extends StoredObject> persons,
 Class<?> processorClass)
                          throws Exception

Throws:

Exception

alert

public static LoginMessage alert(Transaction transaction,
 String message,
 Iterable<? extends StoredObject> persons,
 Class<?> processorClass,
 StoredObject generatedBy)
                          throws Exception

Throws:

Exception

alert

public static LoginMessage alert(Transaction transaction,
 String message,
 StoredObject person,
 int validityInDays)
                          throws Exception

Throws:

Exception

alert

public static LoginMessage alert(Transaction transaction,
 String message,
 StoredObject person,
 StoredObject generatedBy,
 int validityInDays)
                          throws Exception

Throws:

Exception

alert

public static LoginMessage alert(Transaction transaction,
 String message,
 StoredObject person,
 Class<?> processorClass,
 int validityInDays)
                          throws Exception

Throws:

Exception

alert

public static LoginMessage alert(Transaction transaction,
 String message,
 StoredObject person,
 Class<?> processorClass,
 StoredObject generatedBy,
 int validityInDays)
                          throws Exception

Throws:

Exception

alert

public static LoginMessage alert(Transaction transaction,
 String message,
 Iterable<? extends StoredObject> persons,
 int validityInDays)
                          throws Exception

Throws:

Exception

alert

public static LoginMessage alert(Transaction transaction,
 String message,
 Iterable<? extends StoredObject> persons,
 Class<?> processorClass,
 int validityInDays)
                          throws Exception

Throws:

Exception

alert

public static LoginMessage alert(Transaction transaction,
 String message,
 Iterable<? extends StoredObject> persons,
 StoredObject generatedBy,
 int validityInDays)
                          throws Exception

Throws:

Exception

alert

public static LoginMessage alert(Transaction transaction,
 String message,
 Iterable<? extends StoredObject> persons,
 Class<?> processorClass,
 StoredObject generatedBy,
 int validityInDays)
                          throws Exception

Throws:

Exception

validateDelete

public void validateDelete()
                    throws Exception

Description copied from class: StoredObject

This method will be invoked whenever an existing instance is deleted from the database. So, it will be called within an active transaction. Child classes can override this method to do validation when an existing instance is deleted from the database.

Note: When overridden "super" should be called, otherwise, a "design error" will occur.

Also, see StoredObject.validate().

Overrides:

validateDelete in class StoredObject

Throws:

Exception - By raising an exception from this method, the current transaction can be abandoned.

escalate

public LoginMessage escalate(TransactionControl transactionControl,
 Iterable<? extends StoredObject> persons,
 int days)

markAsRead

public boolean markAsRead(TransactionManager tm)

markAsRead

public boolean markAsRead(TransactionManager tm,
 boolean doNotDelete)