com.jalios.jcms.handler
Class EditCatHandler

java.lang.Object
  com.jalios.jcms.context.JcmsContext
      com.jalios.jcms.context.JcmsJspContext
          com.jalios.jcms.handler.JcmsFormHandler
              com.jalios.jcms.handler.EditDataHandler
                  com.jalios.jcms.handler.EditCatHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class EditCatHandler
extends EditDataHandler

This form handler processes editCat.jsp forms.

Version:

$Revision: 36615 $

Author:

Olivier Dedieu

See Also:

Category

Field Summary

static int	ADVANCED_TAB
protected int	authorizedGroupsAddCount
protected TreeSet<Group>	authorizedGroupSet
protected TreeSet<Member>	authorizedMemberSet
protected int	authorizedMemberSetAddCount
protected Category	category
protected int	childrenOrder
protected boolean	childrenOrderProvided
protected String	color
protected String	description
protected HashMap<String,String>	descriptionML
protected TreeSet<String>	friendlyURLSet
static int	GENERAL_TAB
protected String	icon
protected HashMap<String,String>	iconML
protected String	image
protected HashMap<String,String>	imageML
protected String	name
protected HashMap<String,String>	nameML
protected boolean	opAddItemReadRights
protected boolean	opCatDown
protected boolean	opCatUp
protected boolean	opDeepCopy
protected int	openTab
protected Category	parent
static int	PARENT_TAB
static int	PREVIOUS_TAB
static int	READ_RIGHT_TAB
static String	REVISION
protected boolean	selectable
protected String[]	synonyms
protected Category	workingCat
protected boolean	workspaceFilter

Fields inherited from class com.jalios.jcms.handler.EditDataHandler

extFormHandler, formStep, id, isDeleteForced, op, opCancel, opCreate, opDelete, opFinish, opNext, opPrevious, opRefresh, opUpdate, resultOpCreate, resultOpDelete, resultOpUpdate

Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler

contextMap, editFieldSet, noRedirect, noSendRedirect, popupEdition, redirect, redirectOnClosePopup, workspaceForced

Fields inherited from class com.jalios.jcms.context.JcmsJspContext

AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, CSS_HEADER, cssboMap, cssfoMap, CUSTOM_HEADER, editIcon, HTTPEQUIV_HEADER, httpequivMap, HTTPNAME_HEADER, httpnameMap, initEditIcon, JAVASCRIPT_CODE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, jsboSet, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADER

Fields inherited from class com.jalios.jcms.context.JcmsContext

browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, workspace

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, 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, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, 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

Constructor Summary

EditCatHandler()

Method Summary

HashMap	getAllAvailableDescriptionML()
HashMap<String,String>	getAllAvailableIconML()
HashMap<String,String>	getAllAvailableImageML()
HashMap	getAllAvailableNameML()
int	getAuthorizedGroupsCount()
int	getAuthorizedMemberSetCount()
Set<Group>	getAvailableAuthorizedGroupSet()
Set<Member>	getAvailableAuthorizedMemberSet()
int	getAvailableChildrenOrder()
String	getAvailableColor()
String	getAvailableDescription()
String	getAvailableDescription(String lang)
HashMap<String,String>	getAvailableDescriptionML()
TreeSet<String>	getAvailableFriendlyURLSet()
String	getAvailableIcon()
HashMap<String,String>	getAvailableIconML()
String	getAvailableImage()
HashMap<String,String>	getAvailableImageML()
String	getAvailableName()
String	getAvailableName(String lang)
HashMap<String,String>	getAvailableNameML()
Category	getAvailableParent()
boolean	getAvailableSelectable()
String[]	getAvailableSynonyms()
Category	getCategory()
Class	getDataClass()
Set<Group>	getDefaultAuthorizedGroupSet() This method should be overriden by sub-classes
Set<Member>	getDefaultAuthorizedMemberSet() This method should be overriden by sub-classes
int	getOpenTab()
Set<Category>	getRootCategories()
Category	getWorkingCat()
boolean	isExpanded(Category cat)
boolean	isTabForced()
boolean	isWorkspaceFilter()
boolean	performAddItemReadRights()
boolean	performCancel()
protected boolean	performCatDown()
protected boolean	performCatUp()
protected boolean	performCreate()
protected boolean	performDeepCopy()
protected boolean	performDelete()
protected boolean	performUpdate()
boolean	processAction() Method to be implemented to check/validate action to be performed and process them.
protected boolean	processStatus(ControllerStatus status) Process the ControllerStatus: do nothing if OK, or send on forbidden, or put a warning message in the request.
protected void	sendRedirect()
void	setAuthorizedGroupIds(String[] v) Set the Authorized Groups Ids
void	setAuthorizedMemberIds(String[] v) Set the Authorized Members Ids
void	setAuthorizedMemberSetAddCount(int v) The Member Set AddCount
void	setChildrenOrder(int v)
void	setColor(String v)
void	setDescription(String[] v)
void	setFriendlyURL(String[] v) Set the friendly urls.
void	setIcon(String[] v)
void	setId(String id)
void	setImage(String[] v)
void	setName(String[] v)
void	setOpAddItemReadRights(String v)
void	setOpCatDown(String v)
void	setOpCatUp(String v)
void	setOpDeepCopy(String v)
void	setOpenTab(int openTab)
void	setPid(String pid)
void	setSelectable(boolean v)
void	setSynonymList(String v)
void	setWorkspaceFilter(boolean workspaceFilter)
boolean	validateAddItemReadRights()
boolean	validateCancel()
protected boolean	validateCatDown()
protected boolean	validateCatUp()
protected boolean	validateCreate()
protected boolean	validateDeepCopy()
protected boolean	validateDelete()
protected boolean	validateUpdate()

Methods inherited from class com.jalios.jcms.handler.EditDataHandler

afterValidation, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, getAvailableData, getAvailableDataArray, getAvailableExtraDataMap, getAvailableExtraDBDataMap, getControllerContext, getExtFormHandler, getFormStep, getFormStepCount, getId, handleRestResponse, isFirstAccess, performCreateExtension, performFinish, performNext, performPrevious, performRefresh, performUpdateExtension, processDataId, processDataIds, processDataIds, processMLData, processMLDataArray, restValidation, setExtFormHandler, setExtraDBKeys, setExtraDBValues, setExtraKeys, setExtraValues, setFields, setForceDelete, setFormStep, setOpCancel, setOpCreate, setOpDelete, setOpFinish, setOpNext, setOpPrevious, setOpRefresh, setOpUpdate, showCancelButton, showFinishButton, showNextButton, showPreviousButton, validateCreateExtension, validateFinish, validateNext, validatePrevious, validateRefresh, validateUpdateExtension, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocument

Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler

checkMissingField, getEditFieldSet, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getRedirect, getRedirectOnClosePopup, getWorkspace, init, isFieldEdition, isFieldMissing, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, sendRedirect, sendRedirect, setEditField, setNoRedirect, setNoSendRedirect, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, updateUploadedField, updateUploadedFields, validate

Methods inherited from class com.jalios.jcms.context.JcmsJspContext

addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addStyleHeader, addStyleHeader, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSMap, getFinalJavaScriptSet, getFormElementCount, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSONBridge, getPackVersion, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setFormElementCount, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, workaroundBrowserBaseHrefBug

Methods inherited from class com.jalios.jcms.context.JcmsContext

addCookie, addMsg, addMsg, addMsgSession, addMsgSession, applySelector, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getUploadedFile, getUploadedFileList, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAjaxRequest, isDBMember, isDebug, isInFrontOffice, isLogged, isWebdavAccess, removeMessage, removeMessage, retrieveUploadedFile, select, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, validateRegexp, validateSchedule

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final String REVISION

See Also:

Constant Field Values

PREVIOUS_TAB

public static final int PREVIOUS_TAB

See Also:

Constant Field Values

GENERAL_TAB

public static final int GENERAL_TAB

See Also:

Constant Field Values

ADVANCED_TAB

public static final int ADVANCED_TAB

See Also:

Constant Field Values

READ_RIGHT_TAB

public static final int READ_RIGHT_TAB

See Also:

Constant Field Values

PARENT_TAB

public static final int PARENT_TAB

See Also:

Constant Field Values

opDeepCopy

protected boolean opDeepCopy

opCatUp

protected boolean opCatUp

opCatDown

protected boolean opCatDown

opAddItemReadRights

protected boolean opAddItemReadRights

name

protected String name

nameML

protected HashMap<String,String> nameML

description

protected String description

descriptionML

protected HashMap<String,String> descriptionML

synonyms

protected String[] synonyms

selectable

protected boolean selectable

childrenOrder

protected int childrenOrder

childrenOrderProvided

protected boolean childrenOrderProvided

icon

protected String icon

iconML

protected HashMap<String,String> iconML

image

protected String image

imageML

protected HashMap<String,String> imageML

color

protected String color

authorizedMemberSetAddCount

protected int authorizedMemberSetAddCount

authorizedGroupsAddCount

protected int authorizedGroupsAddCount

authorizedMemberSet

protected TreeSet<Member> authorizedMemberSet

authorizedGroupSet

protected TreeSet<Group> authorizedGroupSet

friendlyURLSet

protected TreeSet<String> friendlyURLSet

parent

protected Category parent

workspaceFilter

protected boolean workspaceFilter

category

protected Category category

openTab

protected int openTab

workingCat

protected Category workingCat

Constructor Detail

EditCatHandler

public EditCatHandler()

Method Detail

processAction

public boolean processAction()
                      throws IOException

Description copied from class: JcmsFormHandler

Method to be implemented to check/validate action to be performed and process them.

Default implementation is to return false. No need to call super method.

This method may NOT be invoked at all if security validation are not met.
You must ensure your handler and JSP can work properly without any code invoked in this method.

Overrides:

processAction in class EditDataHandler

Returns:

false if no redirection is needed, true otherwise

Throws:

IOException

isExpanded

public boolean isExpanded(Category cat)

Parameters:

cat - the category to check

Returns:

true if the given category must be expanded

Since:

jcms-3.0

getDataClass

public Class getDataClass()

Specified by:

getDataClass in class EditDataHandler

processStatus

protected boolean processStatus(ControllerStatus status)
                         throws IOException

Description copied from class: JcmsFormHandler

Process the ControllerStatus: do nothing if OK, or send on forbidden, or put a warning message in the request.

Overrides:

processStatus in class JcmsFormHandler

Parameters:

status - the ControllerStatus to be processed

Throws:

IOException

sendRedirect

protected void sendRedirect()
                     throws IOException

Overrides:

sendRedirect in class EditDataHandler

Throws:

IOException

validateCreate

protected boolean validateCreate()
                          throws IOException

Throws:

IOException

performCreate

protected boolean performCreate()
                         throws IOException

Throws:

IOException

validateUpdate

protected boolean validateUpdate()
                          throws IOException

Throws:

IOException

performUpdate

protected boolean performUpdate()
                         throws IOException

Throws:

IOException

validateDelete

protected boolean validateDelete()
                          throws IOException

Throws:

IOException

performDelete

protected boolean performDelete()
                         throws IOException

Throws:

IOException

validateDeepCopy

protected boolean validateDeepCopy()
                            throws IOException

Throws:

IOException

performDeepCopy

protected boolean performDeepCopy()
                           throws IOException

Throws:

IOException

validateCancel

public boolean validateCancel()

Overrides:

validateCancel in class EditDataHandler

performCancel

public boolean performCancel()
                      throws IOException

Overrides:

performCancel in class EditDataHandler

Throws:

IOException

validateCatUp

protected boolean validateCatUp()

performCatUp

protected boolean performCatUp()
                        throws IOException

Throws:

IOException

validateCatDown

protected boolean validateCatDown()

performCatDown

protected boolean performCatDown()
                          throws IOException

Throws:

IOException

validateAddItemReadRights

public boolean validateAddItemReadRights()

performAddItemReadRights

public boolean performAddItemReadRights()
                                 throws IOException

Throws:

IOException

getAvailableName

public String getAvailableName()

getAvailableNameML

public HashMap<String,String> getAvailableNameML()

getAllAvailableNameML

public HashMap getAllAvailableNameML()

getAvailableName

public String getAvailableName(String lang)

getAvailableDescription

public String getAvailableDescription()

getAllAvailableDescriptionML

public HashMap getAllAvailableDescriptionML()

getAvailableDescriptionML

public HashMap<String,String> getAvailableDescriptionML()

getAvailableDescription

public String getAvailableDescription(String lang)

getAvailableSynonyms

public String[] getAvailableSynonyms()

getAvailableSelectable

public boolean getAvailableSelectable()

getAvailableChildrenOrder

public int getAvailableChildrenOrder()

getAvailableIcon

public String getAvailableIcon()

getAvailableIconML

public HashMap<String,String> getAvailableIconML()

getAllAvailableIconML

public HashMap<String,String> getAllAvailableIconML()

getAvailableImage

public String getAvailableImage()

getAvailableImageML

public HashMap<String,String> getAvailableImageML()

getAllAvailableImageML

public HashMap<String,String> getAllAvailableImageML()

getAvailableColor

public String getAvailableColor()

getAvailableParent

public Category getAvailableParent()

setOpenTab

public void setOpenTab(int openTab)

Parameters:

openTab - the tab index to open in the GUI

Since:

jcms-4.1

getOpenTab

public int getOpenTab()

Returns:

the tab index to open in the GUI

Since:

jcms-4.1

isTabForced

public boolean isTabForced()

Returns:

true if the tab to be opened has been set using setOpenTab

Since:

jcms-4.1

getRootCategories

public Set<Category> getRootCategories()

getCategory

public Category getCategory()

setOpCatUp

public void setOpCatUp(String v)

setOpCatDown

public void setOpCatDown(String v)

setOpDeepCopy

public void setOpDeepCopy(String v)

setOpAddItemReadRights

public void setOpAddItemReadRights(String v)

setId

public void setId(String id)

Overrides:

setId in class EditDataHandler

setPid

public void setPid(String pid)

setName

public void setName(String[] v)

setDescription

public void setDescription(String[] v)

setSynonymList

public void setSynonymList(String v)

setSelectable

public void setSelectable(boolean v)

setChildrenOrder

public void setChildrenOrder(int v)

setIcon

public void setIcon(String[] v)

setImage

public void setImage(String[] v)

setColor

public void setColor(String v)

isWorkspaceFilter

public boolean isWorkspaceFilter()

setWorkspaceFilter

public void setWorkspaceFilter(boolean workspaceFilter)

setAuthorizedMemberSetAddCount

public void setAuthorizedMemberSetAddCount(int v)

The Member Set AddCount

Parameters:

v -

Since:

jcms-4.1

getAuthorizedMemberSetCount

public int getAuthorizedMemberSetCount()

Returns:

The Member Set AddCount

Since:

jcms-4.1

getAuthorizedGroupsCount

public int getAuthorizedGroupsCount()

Returns:

The Group Set AddCount

Since:

jcms-4.1

setAuthorizedMemberIds

public void setAuthorizedMemberIds(String[] v)

Set the Authorized Members Ids

Parameters:

v -

Since:

jcms-4.1

setAuthorizedGroupIds

public void setAuthorizedGroupIds(String[] v)

Set the Authorized Groups Ids

Parameters:

v -

Since:

jcms-4.1

getAvailableAuthorizedMemberSet

public Set<Member> getAvailableAuthorizedMemberSet()

Returns:

the Authorized Member Set

Since:

jcms-4.1

getAvailableAuthorizedGroupSet

public Set<Group> getAvailableAuthorizedGroupSet()

Returns:

the Authorized Group Set

Since:

jcms-4.1

getDefaultAuthorizedMemberSet

public Set<Member> getDefaultAuthorizedMemberSet()

This method should be overriden by sub-classes

Returns:

a set of Member or null

Since:

jcms-4.1

getDefaultAuthorizedGroupSet

public Set<Group> getDefaultAuthorizedGroupSet()

This method should be overriden by sub-classes

Returns:

a set of Group or null

Since:

jcms-4.1

setFriendlyURL

public void setFriendlyURL(String[] v)

Set the friendly urls.

Parameters:

v - the friendly url values to use

Since:

jcms-5.5.0

getAvailableFriendlyURLSet

public TreeSet<String> getAvailableFriendlyURLSet()

Returns:

the friendly urls HashMap (including the default language)

getWorkingCat

public Category getWorkingCat()