Class BackgroundProcessInfo
- java.lang.Object
-
- com.jalios.jstore.BasicStorable
-
- com.jalios.jcms.Data
-
- com.jalios.jcms.backgroundprocess.BackgroundProcessInfo
-
- All Implemented Interfaces:
DBData
,JcmsConstants
,ImportConstants
,MashupConstants
,Storable
,JaliosConstants
,LangPropertyArgument
,java.io.Serializable
,java.lang.Cloneable
,java.lang.Comparable<BasicStorable>
public class BackgroundProcessInfo extends Data implements DBData
- Since:
- jcms-10.0.8 / JCMS-9179
- 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 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 BackgroundProcessInfo()
Default constructor.BackgroundProcessInfo(BackgroundProcessInfo other)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canBeReadBy(Member member, boolean searchInGroups, RightInfo rightInfo)
Checks if the specified member is authorized to read this Data.java.lang.String
getCompletedMessage()
java.lang.String
getCompletedMessage(java.lang.String userLang)
java.lang.String
getCompletedMessage(java.lang.String userLang, boolean useDefault)
BackgroundProcess.Status
getCompletedStatus()
int
getCurrentStep()
java.lang.String
getDetailsMessage()
java.lang.String
getDomain()
java.lang.String
getEllapsedFriendlyTime(java.util.Locale locale)
java.lang.Long
getEllapsedTime()
java.lang.String
getLabel(java.lang.String lang)
Retrieve an I18Ned label of this BackgroundProcess, in the specified language.java.lang.String
getLabelProp()
Retrieve the I18N property key to use to provide the I18Ned label of the corresponding BackgroundProcess to the user.boolean
getNotify()
int
getProgress()
Retrieve the progress percentage of the corresponding BackgroundProcessprotected java.lang.String
getRemainingFriendlyTime(java.util.Locale locale)
java.lang.Long
getRemainingTime()
java.lang.String
getRunningMessage()
int
getTotalStep()
java.lang.String
getUridLocation()
boolean
hasProgression()
Check if the corresponding BackgroundProcess has a positive progressboolean
isAuthor(Member member)
Check if given member is the process authorboolean
isCompleted()
Check if a completed status was specified by background process.boolean
isCompletedStatusFailed()
boolean
isCompletedStatusOk()
boolean
isCompletedStatusWarn()
void
setCompletedMessage(java.lang.String completedMessage)
void
setCompletedStatus(BackgroundProcess.Status completedStatus)
void
setCurrentStep(java.lang.Integer currentStep)
void
setDetailsMessage(java.lang.String detailsMessage)
void
setDomain(java.lang.String domain)
void
setLabelProp(java.lang.String prop)
Set the I18N property key to use to provide the I18Ned label of the corresponding BackgroundProcess to the user.void
setNotify(java.lang.Boolean notify)
void
setProgress(java.lang.Integer progress)
Set the progress percentage of the corresponding BackgroundProcessvoid
setRunningMessage(java.lang.String runningMessage)
void
setTotalStep(java.lang.Integer totalStep)
void
setUridLocation(java.lang.String uridLocation)
java.lang.String
toString()
java.lang.String
toString(org.apache.commons.lang3.builder.ToStringStyle style)
-
Methods inherited from class com.jalios.jcms.Data
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, toFullString, 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
-
-
-
-
Constructor Detail
-
BackgroundProcessInfo
public BackgroundProcessInfo()
Default constructor.Inits uridLocation on current channel urid.
- Since:
- jcms-10.0.8
-
BackgroundProcessInfo
public BackgroundProcessInfo(BackgroundProcessInfo other)
- Parameters:
other
- other instance to use- Since:
- jcms-10.0.8
-
-
Method Detail
-
canBeReadBy
public boolean canBeReadBy(Member member, boolean searchInGroups, RightInfo rightInfo)
Description copied from class:Data
Checks if the specified member is authorized to read this Data.- Overrides:
canBeReadBy
in classData
- Parameters:
member
- the member to check (may be null for anonymous user)searchInGroups
- set to true to check for read right authorization using Member's group(s).rightInfo
- aRightInfo
instance in which explanation of read right authorization acceptance or refusal will be indicated. Value is required and cannot be null.- Returns:
- true if member is author, admin, or has backgroundprocess ACL.
- Since:
- jcms-10.0.8
-
isAuthor
public boolean isAuthor(Member member)
Check if given member is the process author- Parameters:
member
- member to check- Returns:
- true if member is author of the process
- Since:
- jcms-10.0.8
-
isCompleted
public boolean isCompleted()
Check if a completed status was specified by background process.- Returns:
- true if completed status is specified, false otherwise.
- Since:
- jcms-10.0.8
-
getProgress
public int getProgress()
Retrieve the progress percentage of the corresponding BackgroundProcess- Returns:
- a percentage value (from 0 to 100)
- Since:
- jcms-10.0.8
-
setProgress
public void setProgress(java.lang.Integer progress)
Set the progress percentage of the corresponding BackgroundProcess- Parameters:
progress
- a percentage value (from 0 to 100)- Since:
- jcms-10.0.8
-
hasProgression
public boolean hasProgression()
Check if the corresponding BackgroundProcess has a positive progress- Returns:
- true if process has a progression percentage
- Since:
- jcms-10.0.8
-
getLabelProp
public java.lang.String getLabelProp()
Retrieve the I18N property key to use to provide the I18Ned label of the corresponding BackgroundProcess to the user.- Returns:
- a property
- Since:
- jcms-10.0.8
-
setLabelProp
public void setLabelProp(java.lang.String prop)
Set the I18N property key to use to provide the I18Ned label of the corresponding BackgroundProcess to the user.- Parameters:
prop
- a property key- Since:
- jcms-10.0.8
-
getLabel
public java.lang.String getLabel(java.lang.String lang)
Retrieve an I18Ned label of this BackgroundProcess, in the specified language.- Parameters:
lang
- an ISO-639 code- Returns:
- a label suitable for prestation to the user
- Since:
- jcms-10.0.8
-
getCurrentStep
public int getCurrentStep()
- Returns:
- current step
- Since:
- jcms-10.0.8
-
setCurrentStep
public void setCurrentStep(java.lang.Integer currentStep)
- Parameters:
currentStep
- current step to set- Since:
- jcms-10.0.8
-
getTotalStep
public int getTotalStep()
- Returns:
- the total step
- Since:
- jcms-10.0.8
-
setTotalStep
public void setTotalStep(java.lang.Integer totalStep)
- Parameters:
totalStep
- total step to set- Since:
- jcms-10.0.8
-
getEllapsedTime
public java.lang.Long getEllapsedTime()
- Returns:
- ellapsed time in millis
- Since:
- jcms-10.0.8
-
getEllapsedFriendlyTime
public java.lang.String getEllapsedFriendlyTime(java.util.Locale locale)
- Parameters:
locale
- locale to use for localization- Returns:
- ellapsed time, formated as localized duration
- Since:
- jcms-10.0.8
-
getRemainingTime
public java.lang.Long getRemainingTime()
- Returns:
- estimated remaining time in millis, never null
- Since:
- jcms-10.0.8
-
getRemainingFriendlyTime
protected java.lang.String getRemainingFriendlyTime(java.util.Locale locale)
- Parameters:
locale
- locale to use for localization- Returns:
- estimated remaining, formated as localized duration
- Since:
- jcms-10.0.8
-
getNotify
public boolean getNotify()
- Returns:
- true if completion must be notified
- Since:
- jcms-10.0.8
-
setNotify
public void setNotify(java.lang.Boolean notify)
- Parameters:
notify
- weither completion must be notified- Since:
- jcms-10.0.8
-
getCompletedStatus
public BackgroundProcess.Status getCompletedStatus()
- Returns:
- the completed status
- Since:
- jcms-10.0.8
-
setCompletedStatus
public void setCompletedStatus(BackgroundProcess.Status completedStatus)
- Parameters:
completedStatus
- the completed status to set- Since:
- jcms-10.0.8
-
isCompletedStatusOk
public boolean isCompletedStatusOk()
- Returns:
- true if status is OK
- Since:
- jcms-10.0.8
-
isCompletedStatusWarn
public boolean isCompletedStatusWarn()
- Returns:
- true if status is WARN
- Since:
- jcms-10.0.8
-
isCompletedStatusFailed
public boolean isCompletedStatusFailed()
- Returns:
- true if status is FAILED
- Since:
- jcms-10.0.8
-
getCompletedMessage
public java.lang.String getCompletedMessage()
- Returns:
- the completedMessage or empty string
- Since:
- jcms-10.0.8
-
getCompletedMessage
public java.lang.String getCompletedMessage(java.lang.String userLang)
- Parameters:
userLang
- user lang- Returns:
- the completed message
- Since:
- jcms-10.0.8
-
getCompletedMessage
public java.lang.String getCompletedMessage(java.lang.String userLang, boolean useDefault)
- Parameters:
userLang
- user languseDefault
- weither if an empty completedMessage should return the default completed message- Returns:
- the completed message
- Since:
- jcms-10.0.8
-
setCompletedMessage
public void setCompletedMessage(java.lang.String completedMessage)
- Parameters:
completedMessage
- the completedMessage to set- Since:
- jcms-10.0.8
-
getRunningMessage
public java.lang.String getRunningMessage()
- Returns:
- the runningMessage or empty string
- Since:
- jcms-10.0.8
-
setRunningMessage
public void setRunningMessage(java.lang.String runningMessage)
- Parameters:
runningMessage
- the runningMessage to set- Since:
- jcms-10.0.8
-
getDetailsMessage
public java.lang.String getDetailsMessage()
- Returns:
- the optionnal details message string
-
setDetailsMessage
public void setDetailsMessage(java.lang.String detailsMessage)
- Parameters:
detailsMessage
- the detailsMessage to set- Since:
- jcms-10.0.8
-
getDomain
public java.lang.String getDomain()
- Returns:
- the domain
- Since:
- jcms-10.0.8
-
setDomain
public void setDomain(java.lang.String domain)
- Parameters:
domain
- the domain to set- Since:
- jcms-10.0.8
-
getUridLocation
public java.lang.String getUridLocation()
- Returns:
- urid where process takes place
- Since:
- jcms-10.0.8
-
setUridLocation
public void setUridLocation(java.lang.String uridLocation)
- Parameters:
uridLocation
- urid to set where process takes place- Since:
- jcms-10.0.8
-
toString
public java.lang.String toString(org.apache.commons.lang3.builder.ToStringStyle style)
-
-