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, java.io.Serializable, java.lang.Cloneable, java.lang.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

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.AuthorizedSelector, 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	Description
`protected boolean`	`finalVote`
`protected int`	`newPstatus`
`protected java.lang.String`	`note`
`protected int`	`prevPstatus`
`protected Publication`	`publication`
`protected java.lang.String`	`publicationId`

Fields inherited from class com.jalios.jcms.Data
author, authorDBID, channel, DISPLAY_URL_EXTRA_INFO, extension, extraDataMap, extraDBDataMapToSaveOnOp, importMap, opAuthor, opDelegate, WRITE_IN_PROGRESS_EXTRA_INFO, WYSIWYG_INLINE_EDIT_REQUEST_PARAMETER

Fields inherited from class com.jalios.jstore.BasicStorable
cdate, ddate, id, isStoreCache, mdate, store

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.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.JcmsConstants
ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DATA_DIRECTORY, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, 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, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_MINI, PHOTO_MINI_HEIGHT, PHOTO_MINI_PROP_PREFIX, PHOTO_MINI_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_DIR, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_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, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

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	Description
`WFNote()`
`WFNote(Publication publication, int prevPstatus, int newPstatus, java.lang.String comment, Member author, DataExtension extension)`
`WFNote(WFNote other)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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.
`java.lang.String`	`getNewStateLabel(java.lang.String userLang)`	Returns the label of the previous state.
`java.lang.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.
`java.lang.String`	`getPrevStateLabel(java.lang.String userLang)`	Returns the label of the previous state.
`Publication`	`getPublication()`	Retrieve the publication associated to this WFNote.
`java.lang.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(java.lang.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(java.lang.String v)`	Sets the JStore ID of the publication.
`java.lang.String`	`toFullString()`
`java.lang.String`	`toString()`

Methods inherited from class com.jalios.jcms.Data
canBeReadBy, canBeReadBy, canBeUnlockedBy, canRequestUnlock, checkAndPerformCreate, checkAndPerformCreate, checkAndPerformDelete, checkAndPerformDelete, checkAndPerformUpdate, checkAndPerformUpdate, checkCreate, checkCreate, checkDelete, checkDelete, checkIntegrity, checkIntegrity, checkLockMember, checkMember, checkStrongLockMember, checkStrongLockMember, checkUpdate, checkUpdate, checkWrite, cleanHybridCollection, cleanHybridCollection, cleanHybridCollection, cleanHybridCollections, clone, computeDBIDArray, computeDBIDList, computeDBIDSet, 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, getDataIconCSS, getDataIconHtml, getDataIconHtml, getDataIconTitle, getDataImage, getDataImage, getDataImage, getDataName, getDataNameComparator, getDate, getDate, getDateSelector, getDeletableSelector, getDisplayLink, getDisplayLink, getDisplayLink, getDisplayLinkCss, getDisplayLinkDataAttribute, getDisplayLinkHtmlAttributes, getDisplayUrl, getDoubleFieldValue, getDoubleFieldValue, getExportXmlDataValue, getExtension, getExtraData, getExtraDataMap, getExtraDBData, getExtraDBDataMap, getExtraInfo, getExtraInfoMap, getFieldStatusMap, getFieldValue, getFieldValue, getFieldValue, getFieldValue, getGenericThumbnail, 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, getOpAuthorId, getOpDelegate, getReadAuthorizedSelector, getReferrerSet, getRowId, getRowIdComparator, getStrongLock, getStrongLockContext, getStrongLockContextData, getStrongLockDate, getStrongLockInfo, getStrongLockMember, getStrongLockSelector, getTypeEntry, getTypeFieldsEntries, getUpdateInstance, getVirtualIDSet, importXml, importXmlFieldsWithReferences, importXmlFiles, importXmlReferences, initializeDBDataCollections, isDBData, isImported, isImportUpdated, isInDatabase, isLocked, isPersisted, isStrongLocked, lock, markNewImport, mergeHybridLink, mergeHybridLink, performAfterWrite, performBeforeWrite, performCreate, performCreate, performDelete, performDelete, performUpdate, performUpdate, prepareUpdateContext, printDataName, printDisplayLinkEnd, printDisplayLinkStart, printDisplayLinkStart, printDisplayUrl, printDisplayUrl, putStrongLock, 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, setOpAuthorId, setOpDelegate, setRowId, splitHybridCollections, toCSV, unlock, unlock, unmarkNewImport, updateDisplayLinkCss, updateDisplayLinkDataAttribute, updateDisplayLinkHtmlAttributes, 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, hashCode, isStored, resetInternalCaches, 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
  - publication
```
protected Publication publication
```
  - publicationId
```
protected java.lang.String publicationId
```
  - prevPstatus
```
protected int prevPstatus
```
  - newPstatus
```
protected int newPstatus
```
  - note
```
protected java.lang.String note
```
  - finalVote
```
protected boolean finalVote
```
- Constructor Detail
  - WFNote
```
public WFNote()
```
  - WFNote
```
public WFNote(Publication publication,
              int prevPstatus,
              int newPstatus,
              java.lang.String comment,
              Member author,
              DataExtension extension)
```
  - WFNote
```
public WFNote(WFNote other)
```
- Method Detail
  - getPrevStateLabel
```
public java.lang.String getPrevStateLabel(java.lang.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 java.lang.String getNewStateLabel(java.lang.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 java.lang.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(java.lang.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 java.lang.String getNote()
```
    Retrieve the note text of this WFNote.
    
    Returns:
    
    the text.
    
    Since:
    
    jcms-6.0.0
  - setNote
```
public void setNote(java.lang.String note)
```
    Set the note text of this WFNote.
    
    Parameters:
    
    note - the text of this WFNote.
    
    Since:
    
    jcms-6.0.0
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class Data
    
    Since:
    
    jcms-4.1
  - toFullString
```
public java.lang.String toFullString()
```
    Overrides:
    
    toFullString in class Data
    
    Since:
    
    jcms-9.0.3
    
    See Also:
    
    Data.toFullString()

Class WFNote

Nested Class Summary

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

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

Field Summary

Fields inherited from class com.jalios.jcms.Data

Fields inherited from class com.jalios.jstore.BasicStorable

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

Fields inherited from interface com.jalios.util.JaliosConstants

Fields inherited from interface com.jalios.jcms.JcmsConstants

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

Constructor Summary

Method Summary

Methods inherited from class com.jalios.jcms.Data

Methods inherited from class com.jalios.jstore.BasicStorable

Methods inherited from class java.lang.Object

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

Field Detail

publication

publicationId

prevPstatus

newPstatus

note

finalVote

Constructor Detail

WFNote

WFNote

WFNote

Method Detail

getPrevStateLabel

getNewStateLabel

getFinalVote

setFinalVote

getPublication

setPublication

getPublicationId

setPublicationId

getPrevPstatus

setPrevPstatus

getNewPstatus

setNewPstatus

getNote

setNote

toString

toFullString