org.opencms.workplace.tools.content

Class CmsMergePages

java.lang.Object

org.opencms.workplace.CmsWorkplace

org.opencms.workplace.tools.CmsToolDialog

org.opencms.workplace.CmsDialog

org.opencms.workplace.CmsMultiDialog

org.opencms.workplace.CmsReport

org.opencms.workplace.tools.content.CmsMergePages

public class CmsMergePages
extends org.opencms.workplace.CmsReport

Provides methods for the merge pages dialog.

Since:

6.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALL A constant representing the select option all templates.
static java.lang.String	DIALOG_TYPE The dialog type.
static int	FOLDER1_EXCLUSIVE Key for pages found in folder 1 exclusivly.
static int	FOLDER2_EXCLUSIVE Key for pages found in folder 2 exclusivly.
static int	FOLDERS_DIFFERENTTYPES Key for pages found in both folders but as different types.
static int	FOLDERS_EQUALNAMES Key for pages found in both folders as individual resources.
static int	FOLDERS_SIBLING Key for pages found in both folders as siblings.
static java.lang.String	PARAM_FOLDER1 Request parameter name for the first folder to merge.
static java.lang.String	PARAM_FOLDER2 Request parameter name for the second folder to merge.

Fields inherited from class org.opencms.workplace.CmsReport

PARAM_REPORT_CONTINUEKEY, PARAM_REPORT_TYPE, REPORT_UPDATE_SIZE, REPORT_UPDATE_TIME

Fields inherited from class org.opencms.workplace.CmsMultiDialog

DELIMITER_RESOURCES, PARAM_RESOURCELIST

Fields inherited from class org.opencms.workplace.CmsDialog

ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_CONTINUE, ACTION_DEFAULT, ACTION_LOCKS_CONFIRMED, ACTION_OK, ACTION_REPORT_BEGIN, ACTION_REPORT_END, ACTION_REPORT_UPDATE, ACTION_SET, ACTION_WAIT, ATTRIBUTE_THROWABLE, BUTTON_ADVANCED, BUTTON_BACK, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTINUE, BUTTON_DETAILS, BUTTON_DISCARD, BUTTON_EDIT, BUTTON_OK, BUTTON_OK_NO_SUBMIT, BUTTON_SET, DIALOG_BACK, DIALOG_CANCEL, DIALOG_CONFIRMED, DIALOG_CONTINUE, DIALOG_INITIAL, DIALOG_LOCKS_CONFIRMED, DIALOG_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, PARAM_ORIGINALPARAMS, PARAM_PREACTIONDONE, PARAM_REDIRECT, PARAM_RESOURCE, PARAM_TARGET, PARAM_THREAD, PARAM_THREAD_HASNEXT, PARAM_TITLE, REPORT_BEGIN, REPORT_END, REPORT_UPDATE

Fields inherited from class org.opencms.workplace.tools.CmsToolDialog

PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

Fields inherited from class org.opencms.workplace.CmsWorkplace

DEBUG, DEFAULT_LANGUAGE, DEFAULT_LOCALE, DIALOG_PATH_COMMON, FILE_DIALOG_CLOSE, FILE_DIALOG_SCREEN_CONFIRM, FILE_DIALOG_SCREEN_ERROR, FILE_DIALOG_SCREEN_ERRORPAGE, FILE_DIALOG_SCREEN_WAIT, FILE_EXPLORER_FILELIST, FILE_REPORT_OUTPUT, HTML_END, HTML_START, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RES_PATH_FILETYPES, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODULES, VFS_PATH_RESOURCES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_DIRECT_EDIT, VIEW_WORKPLACE

Constructor Summary

Constructors

Constructor and Description
CmsMergePages(org.opencms.jsp.CmsJspActionElement jsp) Public constructor with JSP action element.
CmsMergePages(org.opencms.file.CmsObject cms, javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Public constructor with JSP variables.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionMerge(org.opencms.report.I_CmsReport report) Merges the specified resources.
void	actionReport() Performs the move report, will be called by the JSP page.
org.opencms.file.CmsObject	getCms()
java.lang.String	getErrorMessage() Returns the errorMessage.
java.lang.String	getParamFolder1() Returns the first folder.
java.lang.String	getParamFolder2() Returns the second folder.
protected void	initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
void	setErrorMessage(java.lang.String errorMessage) Sets the errorMessage.
void	setParamFolder1(java.lang.String folder1) Sets the first folder to merge.
void	setParamFolder2(java.lang.String folder2) Sets the second folder to merge.
void	validateParameters(org.opencms.file.CmsObject cms) Does validate the request parameters and returns a buffer with error messages.

Methods inherited from class org.opencms.workplace.CmsReport

dialogButtonsContinue, dialogButtonsOkCancelDetails, generateCssStyle, generatePageEndExtended, generatePageEndSimple, generatePageStartExtended, generatePageStartSimple, getParamRefreshWorkplace, getParamReportContinueKey, getParamReportType, getParamThread, getParamThreadHasNext, getReportUpdate, hasError, htmlStart, htmlStart, initCmsReport, isAlive, isSimpleReport, pageHtml, performDialogOperation, reportConclusionText, reportIntroductionText, setParamRefreshWorkplace, setParamReportContinueKey, setParamReportType, setParamThread, setParamThreadHasNext

Methods inherited from class org.opencms.workplace.CmsMultiDialog

addMultiOperationException, buildLockHeaderBox, buildResourceList, checkMultiOperationException, checkResourcePermissions, getParamResourcelist, getResourceList, getResourceListAsParam, isMultiOperation, isOperationOnFolder, setDialogTitle, setParamResource, setParamResourcelist

Methods inherited from class org.opencms.workplace.CmsDialog

actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockDialog, buildLockDialog, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogLockButtons, dialogRow, dialogRowEnd, dialogRowStart, dialogScriptSubmit, dialogSeparator, dialogSpacer, dialogStart, dialogStart, dialogSubheadline, dialogToggleStart, dialogWhiteBox, dialogWhiteBoxEnd, dialogWhiteBoxStart, getAction, getAdministrationBackLink, getCancelAction, getDialogRealUri, getDialogUri, getOnlineHelpUriCustom, getParamAction, getParamCloseLink, getParamDialogtype, getParamFramename, getParamIsPopup, getParamMessage, getParamOriginalParams, getParamPreActionDone, getParamRedirect, getParamResource, getParamTitle, getState, hasCorrectLockstate, hasSiblings, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamTitle

Methods inherited from class org.opencms.workplace.tools.CmsToolDialog

computeUpLevelLink, dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamForce, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamForce, setParamPath, setParamRoot, setParamStyle, useNewStyle

Methods inherited from class org.opencms.workplace.CmsWorkplace

addMessages, addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, getWorkplaceSettings, htmlEnd, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALL

public static final java.lang.String ALL

A constant representing the select option all templates.

See Also:

Constant Field Values

FOLDER1_EXCLUSIVE

public static final int FOLDER1_EXCLUSIVE

Key for pages found in folder 1 exclusivly.

See Also:

Constant Field Values

FOLDER2_EXCLUSIVE

public static final int FOLDER2_EXCLUSIVE

Key for pages found in folder 2 exclusivly.

See Also:

Constant Field Values

FOLDERS_DIFFERENTTYPES

public static final int FOLDERS_DIFFERENTTYPES

Key for pages found in both folders but as different types.

See Also:

Constant Field Values

FOLDERS_EQUALNAMES

public static final int FOLDERS_EQUALNAMES

Key for pages found in both folders as individual resources.

See Also:

Constant Field Values

FOLDERS_SIBLING

public static final int FOLDERS_SIBLING

Key for pages found in both folders as siblings.

See Also:

Constant Field Values

DIALOG_TYPE

public static final java.lang.String DIALOG_TYPE

The dialog type.

See Also:

Constant Field Values

PARAM_FOLDER1

public static final java.lang.String PARAM_FOLDER1

Request parameter name for the first folder to merge.

See Also:

Constant Field Values

PARAM_FOLDER2

public static final java.lang.String PARAM_FOLDER2

Request parameter name for the second folder to merge.

See Also:

Constant Field Values

Constructor Detail

CmsMergePages

public CmsMergePages(org.opencms.jsp.CmsJspActionElement jsp)

Public constructor with JSP action element.

Parameters:

jsp - an initialized JSP action element

CmsMergePages

public CmsMergePages(org.opencms.file.CmsObject cms,
             javax.servlet.jsp.PageContext context,
             javax.servlet.http.HttpServletRequest req,
             javax.servlet.http.HttpServletResponse res)

Public constructor with JSP variables.

Parameters:

cms - the current CmsObject

context - the JSP page context

req - the JSP request

res - the JSP response

Method Detail

actionMerge

public void actionMerge(org.opencms.report.I_CmsReport report)

Merges the specified resources.

Parameters:

report - the cms report

actionReport

public void actionReport()
                  throws javax.servlet.jsp.JspException

Performs the move report, will be called by the JSP page.

Throws:

javax.servlet.jsp.JspException - if problems including sub-elements occur

getCms

public org.opencms.file.CmsObject getCms()

Overrides:

getCms in class org.opencms.workplace.CmsWorkplace

See Also:

CmsWorkplace.getCms()

getErrorMessage

public java.lang.String getErrorMessage()

Returns the errorMessage.

Returns:

the errorMessage

getParamFolder1

public java.lang.String getParamFolder1()

Returns the first folder.

Returns:

the folder

getParamFolder2

public java.lang.String getParamFolder2()

Returns the second folder.

Returns:

the folder

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)

Sets the errorMessage.

Parameters:

errorMessage - the errorMessage to set

setParamFolder1

public void setParamFolder1(java.lang.String folder1)

Sets the first folder to merge.

Parameters:

folder1 - the first folder name to set

setParamFolder2

public void setParamFolder2(java.lang.String folder2)

Sets the second folder to merge.

Parameters:

folder2 - the second folder name to set

validateParameters

public void validateParameters(org.opencms.file.CmsObject cms)

Does validate the request parameters and returns a buffer with error messages.

Parameters:

cms - the current cms object If there were no error messages, the buffer is empty.

initWorkplaceRequestValues

protected void initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings,
                              javax.servlet.http.HttpServletRequest request)

Overrides:

initWorkplaceRequestValues in class org.opencms.workplace.CmsReport

See Also:

CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)