com.jalios.jcms.alert

Class Alert

java.lang.Object

com.jalios.jstore.BasicStorable

com.jalios.jcms.Data

com.jalios.jcms.alert.Alert

All Implemented Interfaces:

DBData, JcmsConstants, ImportConstants, MashupConstants, Storable, JaliosConstants, LangPropertyArgument, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<BasicStorable>

public class Alert
extends Data
implements DBData

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Alert.Level

Nested classes/interfaces inherited from class com.jalios.jcms.Data

Data.AuthorComparator<T extends Data>, Data.AuthorSelector, Data.CdateSelector, Data.DataNameComparator<T extends Data>, Data.DeletableSelector, Data.ImportSelector, Data.MdateSelector, Data.OpAuthorComparator<T extends Data>, Data.RowIdComparator<T extends Data>, Data.StrongLockSelector

Nested classes/interfaces inherited from class com.jalios.jstore.BasicStorable

BasicStorable.CdateComparator<T extends Storable>, BasicStorable.IdComparator<T extends Storable>, BasicStorable.MdateComparator<T extends Storable>

Field Summary

Fields

Modifier and Type	Field and Description
protected Data	data
static java.lang.String	DATA_ID_FIELD
protected java.lang.String	description
protected java.lang.String	domain
static java.lang.String	DOMAIN_FIELD
protected Alert.Level	level
static java.lang.String	LEVEL_FIELD
static java.lang.String	LEVEL_PREFIX_PROP
protected java.lang.String	message
protected java.lang.String	messageMarkup
protected java.lang.String	name
static java.lang.String	NAME_FIELD
protected boolean	read
static java.lang.String	READ_FIELD
static java.lang.String	RECIPIEND_ID_FIELD
protected Member	recipient
static int	SHORT_DESCRIPTION_MAXSIZE
protected java.lang.String	shortDescription
protected java.lang.String	title

Fields inherited from class com.jalios.jcms.Data

author, authorDBID, channel, DISPLAY_URL_EXTRA_INFO, extension, extraDataMap, extraDBDataMapToSaveOnOp, importMap, opAuthor, opDelegate, REVISION

Fields inherited from class com.jalios.jstore.BasicStorable

cdate, ddate, id, mdate, store

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Fields inherited from interface com.jalios.jcms.mashup.ImportConstants

IMPORT_ALARM_MGR, IMPORT_AUTHOR_PROP, IMPORT_CATEGORY_DEFAULT, IMPORT_DC_ATTR, IMPORT_DC_STEP, IMPORT_DIR, IMPORT_ENABLED, IMPORT_JDOM_ELEMENT, IMPORT_LOG_FILE, IMPORT_LOG_MAX, IMPORT_OPTIONS, IMPORT_OPTIONS_DC_CONTEXT, IMPORT_ROOT_PROP, IMPORT_SOURCE_FILE, IMPORT_SOURCE_PREFIX_PROP, IMPORT_SOURCES_DIR, IMPORT_STEP_CLEAN, IMPORT_STEP_IMPORT, IMPORT_STEP_UPDATE_REF, IMPORT_WS_PROP

Fields inherited from interface com.jalios.jcms.mashup.MashupConstants

DATA_TAG, DATASET_TAG, FIELD_CLASS, FIELD_ENTRY, FIELD_ITEM, FIELD_KEY, FIELD_NAME, FIELD_TAG, FIELD_VALUE, FILE_FIELD, FILE_ID, FILE_MTIME, FILE_SIZE, FILE_TAG, FILE_TICKET, FILESET_TAG, RELATED_TAG

Constructor Summary

Constructors

Constructor and Description
Alert()
Alert(Alert.Level level, java.lang.String domain, java.lang.String name, Member recipient, Data data, Member author)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canBeSaved()
ControllerStatus	checkIntegrity() Checks whether or not data integrity constraints are respected.
java.util.Map<java.lang.String,java.lang.Object>	getContext()
Data	getData()
java.lang.String	getDataId()
java.lang.String	getDescription()
java.lang.String	getDomain()
java.lang.String	getFullName() Returns the full name of the alert (domain + name).
Alert.Level	getLevel()
int	getLevelValue()
java.lang.String	getMessage()
java.lang.String	getMessageMarkup()
java.lang.String	getName()
Member	getRecipient()
java.lang.String	getRecipientId()
java.lang.String	getShortDescription()
java.lang.String	getTitle()
boolean	hasMessage() Returns true if a message is attached to this alert.
boolean	isRead()
boolean	matches(AlertRule rule) Returns true if this alert matches the given rule.
void	setAuthorId(java.lang.String authordId) Sets the JStore ID of the author (only for DBData).
void	setCanBeSaved(boolean canBeSaved)
void	setContext(java.util.Map<java.lang.String,java.lang.Object> context)
void	setData(Data data)
void	setDataId(java.lang.String v)
void	setDescription(java.lang.String description)
void	setDomain(java.lang.String domain)
void	setLevel(Alert.Level level)
void	setLevelValue(int v)
void	setMessage(java.lang.String message)
void	setMessageMarkup(java.lang.String messageMarkup)
void	setName(java.lang.String name)
void	setRead(boolean read)
void	setRecipient(Member recipient)
void	setRecipientId(java.lang.String v)
void	setShortDescription(java.lang.String shortDescription)
void	setTitle(java.lang.String title)
java.lang.String	toString()

Methods inherited from class com.jalios.jcms.Data

canRequestUnlock, checkCreate, checkCreate, checkDelete, checkDelete, checkIntegrity, checkLockMember, checkMember, checkStrongLockMember, checkUpdate, checkUpdate, checkWrite, clone, computeDBIDArray, exportXml, exportXml, exportXml, exportXml, exportXmlField, exportXmlRelated, exportXmlRelated, fillExportXmlFieldAttributes, getAllReferrerSet, getAllReferrerSet, getAllTypeFieldEntry, getAuthor, getAuthor, getAuthorComparator, getAuthorDBID, getAuthorId, getAuthorSelector, getBooleanFieldValue, getBooleanFieldValue, getCaddyComparator, getCategoryFieldValue, getCategoryFieldValue, getCdateSelector, getComparator, getCSVHeader, getDataIcon, getDataIconAlt, getDataIconHtml, getDataIconHtml, getDataIconTitle, getDataImage, getDataImage, getDataImage, getDataName, getDataNameComparator, getDate, getDate, getDateSelector, getDeletableSelector, getDisplayLink, getDisplayLink, getDisplayLink, getDisplayUrl, getDoubleFieldValue, getDoubleFieldValue, getExportXmlDataValue, getExtension, getExtraData, getExtraDataMap, getExtraDBData, getExtraDBDataMap, getExtraInfo, getExtraInfoMap, getFieldStatusMap, getFieldValue, getFieldValue, getFieldValue, getFieldValue, getGenericThumbnail, getImportAuthor, getImportBatch, getImportDate, getImportDisplayUrl, getImportId, getImportMap, getImportMdate, getImportSelector, getImportSignature, getImportSource, getImportSourceUrl, getImportUrl, getIntFieldValue, getIntFieldValue, getLangPropertyValue, getLinkCount, getLinkIndexedDataSet, getLinkIndexedDataSet, getLockDate, getLockInfo, getLockMember, getLongFieldValue, getLongFieldValue, getMdateSelector, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getOpAuthor, getOpAuthorComparator, getOpDelegate, getRowId, getRowIdComparator, getStrongLock, getStrongLockDate, getStrongLockInfo, getStrongLockMember, getStrongLockSelector, getTypeEntry, getTypeFieldsEntries, getUpdateInstance, getVirtualIDSet, hashCode, importXml, importXmlFieldsWithReferences, importXmlFiles, importXmlReferences, initializeDBDataCollections, isDBData, isImported, isImportUpdated, isInDatabase, isLocked, isPersisted, isStrongLocked, lock, markNewImport, mergeHybridLink, performAfterWrite, performBeforeWrite, performCreate, performCreate, performDelete, performDelete, performUpdate, performUpdate, prepareUpdateContext, printDataName, printDisplayLinkEnd, printDisplayLinkStart, printDisplayUrl, printDisplayUrl, putStrongLock, releaseStrongLock, releaseStrongLock, removeExtraData, removeExtraDBData, removeExtraInfo, setAuthor, setAuthorDBID, setBooleanFieldValue, setCategoryFieldValue, setDoubleFieldValue, setExtension, setExtraData, setExtraDataMap, setExtraDBData, setExtraDBDataMap, setExtraDBDataMap, setExtraInfo, setFieldValue, setFieldValue, setImportAuthor, setImportBatch, setImportDate, setImportDisplayUrl, setImportId, setImportMap, setImportMdate, setImportSignature, setImportSource, setImportSourceUrl, setImportUpdated, setIntFieldValue, setLongFieldValue, setMdate, setOpAuthor, setOpDelegate, setRowId, toCSV, toFullString, unlock, unlock, unmarkNewImport, updateExtraDataMap, updateExtraDBDataMap, updateIndexTreeSet

Methods inherited from class com.jalios.jstore.BasicStorable

clearId, compareTo, equals, getAttribute, getAttributes, getCdate, getCdateComparator, getDdate, getId, getIdComparator, getMdate, getMdateComparator, getStore, getUrid, hasBeenUpdated, isStored, resolveAtt, resolveVal, setAttributes, setAttributes, setCdate, setDdate, setId, setStore, toXml

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jalios.jcms.db.DBData

getRowId, setRowId

Field Detail

LEVEL_PREFIX_PROP

public static final java.lang.String LEVEL_PREFIX_PROP

See Also:

Constant Field Values

SHORT_DESCRIPTION_MAXSIZE

public static final int SHORT_DESCRIPTION_MAXSIZE

See Also:

Constant Field Values

RECIPIEND_ID_FIELD

public static final java.lang.String RECIPIEND_ID_FIELD

See Also:

Constant Field Values

LEVEL_FIELD

public static final java.lang.String LEVEL_FIELD

See Also:

Constant Field Values

DOMAIN_FIELD

public static final java.lang.String DOMAIN_FIELD

See Also:

Constant Field Values

NAME_FIELD

public static final java.lang.String NAME_FIELD

See Also:

Constant Field Values

READ_FIELD

public static final java.lang.String READ_FIELD

See Also:

Constant Field Values

DATA_ID_FIELD

public static final java.lang.String DATA_ID_FIELD

See Also:

Constant Field Values

recipient

protected Member recipient

level

protected Alert.Level level

domain

protected java.lang.String domain

name

protected java.lang.String name

data

protected Data data

title

protected java.lang.String title

description

protected java.lang.String description

shortDescription

protected java.lang.String shortDescription

message

protected java.lang.String message

messageMarkup

protected java.lang.String messageMarkup

read

protected boolean read

Constructor Detail

Alert

public Alert()

Alert

public Alert(Alert.Level level,
     java.lang.String domain,
     java.lang.String name,
     Member recipient,
     Data data,
     Member author)

Method Detail

getFullName

public java.lang.String getFullName()

Returns the full name of the alert (domain + name).

Returns:

the full name of the alert (domain + name).

Since:

jcms-8.0.0

hasMessage

public boolean hasMessage()

Returns true if a message is attached to this alert.

Returns:

true if a message is attached to this alert.

Since:

jcms-8.0.0

checkIntegrity

public ControllerStatus checkIntegrity()

Description copied from class: Data

Checks whether or not data integrity constraints are respected.

Overrides:

checkIntegrity in class Data

Returns:

a ControllerStatus

matches

public boolean matches(AlertRule rule)

Returns true if this alert matches the given rule.

Parameters:

rule - the rule

Returns:

true if this alert matches the given rule.

Since:

jcms-8.0.0

setAuthorId

public void setAuthorId(java.lang.String authordId)

Description copied from class: Data

Sets the JStore ID of the author (only for DBData).

If the specified authorId is an invalid ID (non existing Member), the author will be set to the Member specified by property channel.default-author (or left null if this property has not been set).

Overrides:

setAuthorId in class Data

Parameters:

authordId - the JStore author id

getRecipient

public Member getRecipient()

setRecipient

public void setRecipient(Member recipient)

getRecipientId

public java.lang.String getRecipientId()

setRecipientId

public void setRecipientId(java.lang.String v)

getLevelValue

public int getLevelValue()

setLevelValue

public void setLevelValue(int v)

getLevel

public Alert.Level getLevel()

setLevel

public void setLevel(Alert.Level level)

getDomain

public java.lang.String getDomain()

setDomain

public void setDomain(java.lang.String domain)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getData

public Data getData()

setData

public void setData(Data data)

getDataId

public java.lang.String getDataId()

setDataId

public void setDataId(java.lang.String v)

isRead

public boolean isRead()

setRead

public void setRead(boolean read)

getTitle

public java.lang.String getTitle()

setTitle

public void setTitle(java.lang.String title)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getShortDescription

public java.lang.String getShortDescription()

setShortDescription

public void setShortDescription(java.lang.String shortDescription)

getMessage

public java.lang.String getMessage()

setMessage

public void setMessage(java.lang.String message)

getMessageMarkup

public java.lang.String getMessageMarkup()

setMessageMarkup

public void setMessageMarkup(java.lang.String messageMarkup)

canBeSaved

public boolean canBeSaved()

setCanBeSaved

public void setCanBeSaved(boolean canBeSaved)

setContext

public void setContext(java.util.Map<java.lang.String,java.lang.Object> context)

getContext

public java.util.Map<java.lang.String,java.lang.Object> getContext()

toString

public java.lang.String toString()

Overrides:

toString in class Data