com.jalios.jcms
Class WFNote

java.lang.Object
  com.jalios.jstore.BasicStorable
      com.jalios.jcms.Data
          com.jalios.jcms.WFNote

All Implemented Interfaces:

DBData, JcmsConstants, ImportConstants, MashupConstants, Storable, JaliosConstants, LangPropertyArgument, Serializable, Cloneable, Comparable<BasicStorable>

public class WFNote
extends Data
implements DBData

This class represents a small note about a state change in the workflow.

Since:

jcms-2.1

Version:

$Revision: 27753 $

Author:

Olivier Dedieu

See Also:

Serialized Form

Nested Class Summary

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

protected boolean	finalVote
protected int	newPstatus
protected String	note
protected int	prevPstatus
protected Publication	publication
protected String	publicationId
static String	REVISION

Fields inherited from class com.jalios.jcms.Data

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

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_DEEP_COPY, OP_DEEP_DELETE, OP_DELETE, OP_MERGE, OP_UPDATE, 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, 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

WFNote()

WFNote(Publication publication, int prevPstatus, int newPstatus, String comment, Member author, DataExtension extension)

WFNote(WFNote other)

Method Summary

boolean	getFinalVote() Returns true if the WFNote is the final in a vote.
int	getNewPstatus() Retrieve the pstatus in which the Publication is after the update associated with this WFNote.
String	getNewStateLabel(String userLang) Returns the label of the previous state.
String	getNote() Retrieve the note text of this WFNote.
int	getPrevPstatus() Retrieve the pstatus in which the Publication was prior to the change associated to this WFNote.
String	getPrevStateLabel(String userLang) Returns the label of the previous state.
Publication	getPublication() Retrieve the publication associated to this WFNote.
String	getPublicationId() Returns the JStore ID of the publication.
void	setFinalVote(boolean finalVote) Sets this WFNote as final vote.
void	setNewPstatus(int pstatus) Set the pstatus in which the Publication is after the update associated with this WFNote.
void	setNote(String note) Set the note text of this WFNote.
void	setPrevPstatus(int pstatus) Set the pstatus in which the Publication was prior to the update associated with this WFNote.
void	setPublication(Publication pub) Set the publication associated to this WFNote.
void	setPublicationId(String v) Sets the JStore ID of the publication.
String	toString()

Methods inherited from class com.jalios.jcms.Data

canRequestLock, checkCreate, checkCreate, checkDelete, checkDelete, checkIntegrity, 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, getDataImage, getDataImage, getDataImage, getDataName, getDataNameComparator, getDate, getDate, getDateSelector, getDeletableSelector, 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, 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, setAuthorId, 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, 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

REVISION

public static final String REVISION

See Also:

Constant Field Values

publication

protected Publication publication

publicationId

protected String publicationId

prevPstatus

protected int prevPstatus

newPstatus

protected int newPstatus

note

protected String note

finalVote

protected boolean finalVote

Constructor Detail

WFNote

public WFNote()

WFNote

public WFNote(Publication publication,
              int prevPstatus,
              int newPstatus,
              String comment,
              Member author,
              DataExtension extension)

WFNote

public WFNote(WFNote other)

Method Detail

toString

public String toString()

Overrides:

toString in class Data

Since:

jcms-4.1

getPrevStateLabel

public String getPrevStateLabel(String userLang)

Returns the label of the previous state.

Parameters:

userLang - the user language.

Returns:

the label of the previous state.

Since:

jcms-5.7.0

getNewStateLabel

public String getNewStateLabel(String userLang)

Returns the label of the previous state.

Parameters:

userLang - the user language.

Returns:

the label of the previous state.

Since:

jcms-5.7.0

getFinalVote

public boolean getFinalVote()

Returns true if the WFNote is the final in a vote.

Returns:

true if the WFNote is the final in a vote.

Since:

jcms-6.0.0

setFinalVote

public void setFinalVote(boolean finalVote)

Sets this WFNote as final vote.

Parameters:

finalVote - the boolean value.

Since:

jcms-6.0.0

getPublication

public Publication getPublication()

Retrieve the publication associated to this WFNote.

Returns:

the Publication associated to this WFNote.

Since:

jcms-2.1

setPublication

public void setPublication(Publication pub)

Set the publication associated to this WFNote.

Parameters:

pub - a Publication.

Since:

jcms-2.1

getPublicationId

public String getPublicationId()

Returns the JStore ID of the publication.

Returns:

the JStore ID of the publication

Since:

jcms-6.0.0

setPublicationId

public void setPublicationId(String v)

Sets the JStore ID of the publication.

Parameters:

v - the JStore publication id

Since:

jcms-6.0.0

getPrevPstatus

public int getPrevPstatus()

Retrieve the pstatus in which the Publication was prior to the change associated to this WFNote.

Returns:

the previous pstatus.

Since:

jcms-2.1

setPrevPstatus

public void setPrevPstatus(int pstatus)

Set the pstatus in which the Publication was prior to the update associated with this WFNote.

Parameters:

pstatus - the previous pstatus.

Since:

jcms-2.1

getNewPstatus

public int getNewPstatus()

Retrieve the pstatus in which the Publication is after the update associated with this WFNote.

Returns:

the new pstatus.

Since:

jcms-2.1

setNewPstatus

public void setNewPstatus(int pstatus)

Set the pstatus in which the Publication is after the update associated with this WFNote.

Parameters:

pstatus - the new pstatus.

Since:

jcms-2.1

getNote

public String getNote()

Retrieve the note text of this WFNote.

Returns:

the text.

Since:

jcms-6.0.0

setNote

public void setNote(String note)

Set the note text of this WFNote.

Parameters:

note - the text of this WFNote.

Since:

jcms-6.0.0