java.lang.Object
- com.jalios.jcms.backgroundprocess.BackgroundProcess
- - com.jalios.jcms.search.AdminSearchEngineProcess

All Implemented Interfaces:

JcmsConstants, JaliosConstants
```
public class AdminSearchEngineProcess
extends BackgroundProcess
```
Since:

jcms-10.0.8 JCMS-9179

Nested Class Summary
- Nested classes/interfaces inherited from class com.jalios.jcms.backgroundprocess.BackgroundProcess
  BackgroundProcess.Scope, BackgroundProcess.Status

Field Summary
- Fields inherited from class com.jalios.jcms.backgroundprocess.BackgroundProcess
  COMPLETED_PROGRESS, DEFAULT_LABEL_PROP, MGR
- 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

Constructor Summary

Constructors
Constructor Description

AdminSearchEngineProcess(AdminSearchEnginesHandler.Action action)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getLabelProp()`	Retrieve the I18N property key to use to provide the I18Ned label of this BackgroundProcess to the user.
`void`	`incrementStep()`	Increment the step number of this processing by one.
`protected void`	`runProcess()`	Override to implement the process.
`void`	`setCurrentStep(int stepNbr)`	Set the current step number of this processing.
`void`	`setTotalStep(int totalStepNbr)`	Set the total number of step that this BackgroundProcess will do before reaching completion.

Methods inherited from class com.jalios.jcms.backgroundprocess.BackgroundProcess
allowNulLAuthor, canBeNotified, canStart, channel, debugSleep, getAuthor, getCompletedMessage, getCompletedMessage, getCompletedMessage, getCompletedStatus, getCurrentStep, getDetailsMessage, getDomain, getInfo, getInfoId, getLabel, getProgress, getRunningMessage, getStartTime, getTotalStep, getUserLang, getUserLocale, glp, handleComplete, hasProgression, isAuthor, isCompleted, isCompletedFailed, isCompletedSuccess, isCompletedWarn, save, setCompletedMessage, setCompletedStatus, setDetailsMessage, setLabelProp, setProgress, setRunningMessage, setStartTime, start, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AdminSearchEngineProcess
```
public AdminSearchEngineProcess(AdminSearchEnginesHandler.Action action)
```
    Parameters:
    
    action - action to be run
    
    Since:
    
    jcms-10.0.8 JCMS-9179
- Method Detail
  - runProcess
```
protected void runProcess()
```
    Description copied from class: BackgroundProcess
    
    Override to implement the process.
    
    Specified by:
    
    runProcess in class BackgroundProcess
    
    Since:
    
    jcms-10.0.8 JCMS-9179
  - setTotalStep
```
public void setTotalStep(int totalStepNbr)
```
    Description copied from class: BackgroundProcess
    
    Set the total number of step that this BackgroundProcess will do before reaching completion.
    Implementation detail : If this call changes the progress percentage, it triggers an update in database of the BackgroundProcessInfo used to track the process progress
    
    Overrides:
    
    setTotalStep in class BackgroundProcess
    
    Parameters:
    
    totalStepNbr - a number of steps
    
    Since:
    
    jcms-10.0.8 JCMS-9179
  - incrementStep
```
public void incrementStep()
```
    Description copied from class: BackgroundProcess
    
    Increment the step number of this processing by one.
    Implementation detail : If this step changes the progress percentage, it triggers an update in database of the BackgroundProcessInfo used to track the process progress
    
    Overrides:
    
    incrementStep in class BackgroundProcess
    
    Since:
    
    jcms-10.0.8 JCMS-9179
  - setCurrentStep
```
public void setCurrentStep(int stepNbr)
```
    Description copied from class: BackgroundProcess
    
    Set the current step number of this processing.
    Implementation detail : If this step changes the progress percentage, it triggers an update in database of the BackgroundProcessInfo used to track the process progress
    
    Overrides:
    
    setCurrentStep in class BackgroundProcess
    
    Parameters:
    
    stepNbr - the step number to set
    
    Since:
    
    jcms-10.0.8 JCMS-9179
  - getLabelProp
```
public java.lang.String getLabelProp()
```
    Description copied from class: BackgroundProcess
    
    Retrieve the I18N property key to use to provide the I18Ned label of this BackgroundProcess to the user.
    
    Overrides:
    
    getLabelProp in class BackgroundProcess
    
    Returns:
    
    a property
    
    Since:
    
    jcms-10.0.8 JCMS-9179

Class AdminSearchEngineProcess

Nested Class Summary

Nested classes/interfaces inherited from class com.jalios.jcms.backgroundprocess.BackgroundProcess

Field Summary

Fields inherited from class com.jalios.jcms.backgroundprocess.BackgroundProcess

Fields inherited from interface com.jalios.util.JaliosConstants

Fields inherited from interface com.jalios.jcms.JcmsConstants

Constructor Summary

Method Summary

Methods inherited from class com.jalios.jcms.backgroundprocess.BackgroundProcess

Methods inherited from class java.lang.Object

Constructor Detail

AdminSearchEngineProcess

Method Detail

runProcess

setTotalStep

incrementStep

setCurrentStep

getLabelProp