com.jalios.jcms.handler

Class EditDataHandler

java.lang.Object

com.jalios.jcms.context.JcmsContext

com.jalios.jcms.context.JcmsJspContext

com.jalios.jcms.handler.JcmsFormHandler

com.jalios.jcms.handler.EditDataHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

Direct Known Subclasses:

AbstractEditWorkspaceHandler, AlertListHandler, EditAclHandler, EditCatHandler, EditDataIdHandler, EditExtraDataHandler, EditGroupHandler, EditMemberHandler, EditNotificationCriteriaHandler, EditNotificationHandler, EditPublicationHandler, EditTypeExtensionHandler, EditWorkflowInstanceHandler, EditWSTypeEntryHandler, MembersCsvImportHandler

public abstract class EditDataHandler
extends JcmsFormHandler

This class is the super class of all FormHandler which manage stored data.

Version:

$Revision: 54092 $

See Also:

Data

Field Summary

Fields

Modifier and Type	Field and Description
protected EditTypeExtensionHandler	extFormHandler
protected int	formStep
protected java.lang.String	id
protected boolean	isDeleteForced
protected boolean	op
protected boolean	opCancel
protected boolean	opCreate
protected boolean	opDelete
protected boolean	opFinish
protected boolean	opNext
protected boolean	opPrevious
protected boolean	opRefresh
protected boolean	opUpdate
protected boolean	resultOpCreate
protected boolean	resultOpDelete
protected boolean	resultOpUpdate
static java.lang.String	REVISION

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, ADVANCED_TAB, 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_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, 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, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, 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, 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, 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

Constructors

Constructor and Description
EditDataHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	afterValidation(boolean result)
protected boolean	createUploadedFileDocument(Data[] datas, java.util.Map dataML, Member author, Workspace ws) Performs create on given array of data if it is a FileDocument that have just been uploaded.
protected boolean	createUploadedFileDocument(Data[] datas, Member author, Workspace ws) Performs create on given array of data if it is a FileDocument that have just been uploaded.
protected boolean	createUploadedFileDocument(Data data, java.util.Map dataML, Member author, Workspace ws) Performs create on given array of data if it is a FileDocument that have just been uploaded.
protected boolean	createUploadedFileDocument(Data data, Member author, Workspace ws) Performs create on given data if it is a FileDocument that have just been uploaded.
Data	getAvailableData(Data data, Data dataField, Data field, java.util.Map mlMap, java.lang.String lang) Generic method to get available ML field for a given data in a given language.
Data[]	getAvailableDataArray(Data data, Data[] dataField, Data[] field, java.util.Map mlMap, java.lang.String lang) Generic method to get available ML field for a given array of data in a given language.
java.util.Map<java.lang.String,java.lang.String>	getAvailableExtraDataMap() Returns a Map of available extra data.
java.util.Map<java.lang.String,java.lang.String>	getAvailableExtraDBDataMap() Returns a Map of available extra db data.
protected java.util.HashMap<java.lang.String,java.lang.Object>	getControllerContext() Build a controller context.
abstract java.lang.Class<? extends Data>	getDataClass()
EditTypeExtensionHandler	getExtFormHandler()
int	getFormStep() Retrieve the current step of edition when invoking this form handler.
int	getFormStepCount() Retrieve the total number of steps used for edition when invoking this form handler.
java.lang.String	getId()
protected void	handleRestResponse()
boolean	isFirstAccess() Returns true if this is the first access to this form (no previous submission).
boolean	performCancel()
protected DataExtension	performCreateExtension()
protected boolean	performFinish()
protected boolean	performNext()
protected boolean	performPrevious()
boolean	performRefresh()
protected DataExtension	performUpdateExtension(DataExtension extension)
boolean	processAction() Method to be implemented to check/validate action to be performed and process them.
protected Data	processDataId(java.lang.String fieldName, java.lang.String dataId, java.lang.Class<? extends Data> clazz) Computes given dataid, trim and retrieve associated data.
protected <T extends Data> java.util.List<T>	processDataIds(java.lang.String fieldName, java.lang.String[] ids, java.lang.Class<T> clazz) Computes link array to retrieve Data of the given Class.
protected <T extends Data> java.util.List<T>	processDataIds(java.lang.String fieldName, java.lang.String[] ids, java.lang.Class<T> clazz, boolean trim) Computes link array to retrieve Data of the given Class.
Data	processMLData(java.lang.String fieldName, java.lang.Class clazz, java.lang.String[] values, java.util.Map mlMap) Process the given ML values (data ids)
<T extends Data> Data[]	processMLDataArray(java.lang.String fieldName, java.lang.Class<T> clazz, java.lang.String[] values, java.util.Map mlMap) Process the given ML values (data ids)
protected boolean	restValidation(boolean result)
protected void	sendRedirect()
void	setExtFormHandler(EditTypeExtensionHandler handler)
void	setExtraDBKeys(java.lang.String[] extraDBKeys) Convenient methods to update ExtraDBDataMap from bean
void	setExtraDBValues(java.lang.String[] extraDBValues) Convenient methods to update ExtraDBDataMap from bean
void	setExtraKeys(java.lang.String[] extraKeys) Convenient methods to update ExtraDataMap from bean
void	setExtraValues(java.lang.String[] extraValues) Convenient methods to update ExtraDataMap from bean
void	setFields(Data data) Set the common (Data) fields.
void	setForceDelete(java.lang.String v)
void	setFormStep(int step) Set the current step of edition when invoking this form handler.
void	setId(java.lang.String id)
void	setOpCancel(java.lang.String v)
void	setOpCreate(java.lang.String v)
void	setOpDelete(java.lang.String v)
void	setOpFinish(java.lang.String v)
void	setOpNext(java.lang.String v)
void	setOpPrevious(java.lang.String v)
void	setOpRefresh(java.lang.String v)
void	setOpUpdate(java.lang.String v)
boolean	showCancelButton() Check if the "Cancel" button should be displayed in step modal form.
boolean	showFinishButton() Check if the "Finish" button should be displayed in step modal form.
boolean	showNextButton() Check if the "Next" button should be displayed in step modal form.
boolean	showPreviousButton() Check if the "Previous" button should be displayed in step modal form.
boolean	validateCancel()
protected boolean	validateCreateExtension(Data extendedData)
protected boolean	validateFinish()
protected boolean	validateNext()
protected boolean	validatePrevious()
boolean	validateRefresh()
protected boolean	validateUpdateExtension(DataExtension extension, Data extendedData)
protected boolean	validateUploadedFileDocument(Data[] datas, java.util.Map dataML, Member author, Workspace ws) Performs create on given data if it is a FileDocument that have just been uploaded.
protected boolean	validateUploadedFileDocument(Data[] datas, Member author, Workspace ws) Performs validate on given array of data if it is a FileDocument that have just been uploaded.
protected boolean	validateUploadedFileDocument(Data data, java.util.Map dataML, Member author, Workspace ws) Performs create on given data if it is a FileDocument that have just been uploaded.
protected boolean	validateUploadedFileDocument(Data data, Member author, Workspace ws) Performs create on given data if it is a FileDocument that have just been uploaded.

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, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getRedirect, getRedirectOnClosePopup, getWorkspace, init, isFieldEdition, isFieldMissing, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, processStatus, 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, addPrefetchHeader, 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, 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 java.lang.String REVISION

See Also:

Constant Field Values

op

protected boolean op

opCreate

protected boolean opCreate

resultOpCreate

protected boolean resultOpCreate

opUpdate

protected boolean opUpdate

resultOpUpdate

protected boolean resultOpUpdate

opDelete

protected boolean opDelete

resultOpDelete

protected boolean resultOpDelete

opCancel

protected boolean opCancel

opRefresh

protected boolean opRefresh

opPrevious

protected boolean opPrevious

opNext

protected boolean opNext

opFinish

protected boolean opFinish

id

protected java.lang.String id

extFormHandler

protected EditTypeExtensionHandler extFormHandler

isDeleteForced

protected boolean isDeleteForced

formStep

protected int formStep

Constructor Detail

EditDataHandler

public EditDataHandler()

Method Detail

sendRedirect

protected void sendRedirect()
                     throws java.io.IOException

Throws:

java.io.IOException

afterValidation

protected boolean afterValidation(boolean result)
                           throws java.io.IOException

Overrides:

afterValidation in class JcmsFormHandler

Throws:

java.io.IOException

processAction

public boolean processAction()
                      throws java.io.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 JcmsFormHandler

Returns:

false if no redirection is needed, true otherwise

Throws:

java.io.IOException

validatePrevious

protected boolean validatePrevious()
                            throws java.io.IOException

Throws:

java.io.IOException

performPrevious

protected boolean performPrevious()
                           throws java.io.IOException

Throws:

java.io.IOException

validateNext

protected boolean validateNext()
                        throws java.io.IOException

Throws:

java.io.IOException

performNext

protected boolean performNext()
                       throws java.io.IOException

Throws:

java.io.IOException

validateFinish

protected boolean validateFinish()
                          throws java.io.IOException

Throws:

java.io.IOException

performFinish

protected boolean performFinish()
                         throws java.io.IOException

Throws:

java.io.IOException

getControllerContext

protected java.util.HashMap<java.lang.String,java.lang.Object> getControllerContext()

Description copied from class: JcmsFormHandler

Build a controller context. I.E. add request, response and loggedMember.

Overrides:

getControllerContext in class JcmsFormHandler

Returns:

the HashMap which contains the context

setFields

public void setFields(Data data)

Set the common (Data) fields. This method is also a hook for sub-classed to fill some field (or do anything else) before a create or an update.

Parameters:

data - the publication to set the fields

Since:

jcms-5.7.1

getDataClass

public abstract java.lang.Class<? extends Data> getDataClass()

validateCreateExtension

protected boolean validateCreateExtension(Data extendedData)
                                   throws java.io.IOException

Throws:

java.io.IOException

performCreateExtension

protected DataExtension performCreateExtension()
                                        throws java.io.IOException

Throws:

java.io.IOException

validateUpdateExtension

protected boolean validateUpdateExtension(DataExtension extension,
                              Data extendedData)
                                   throws java.io.IOException

Throws:

java.io.IOException

performUpdateExtension

protected DataExtension performUpdateExtension(DataExtension extension)
                                        throws java.io.IOException

Throws:

java.io.IOException

validateCancel

public boolean validateCancel()

performCancel

public boolean performCancel()
                      throws java.io.IOException

Throws:

java.io.IOException

validateRefresh

public boolean validateRefresh()

performRefresh

public boolean performRefresh()
                       throws java.io.IOException

Throws:

java.io.IOException

setOpCreate

public void setOpCreate(java.lang.String v)

setOpUpdate

public void setOpUpdate(java.lang.String v)

setOpDelete

public void setOpDelete(java.lang.String v)

setOpCancel

public void setOpCancel(java.lang.String v)

setOpRefresh

public void setOpRefresh(java.lang.String v)

setOpPrevious

public void setOpPrevious(java.lang.String v)

setOpNext

public void setOpNext(java.lang.String v)

setOpFinish

public void setOpFinish(java.lang.String v)

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

setForceDelete

public void setForceDelete(java.lang.String v)

getExtFormHandler

public EditTypeExtensionHandler getExtFormHandler()

setExtFormHandler

public void setExtFormHandler(EditTypeExtensionHandler handler)

showCancelButton

public boolean showCancelButton()

Check if the "Cancel" button should be displayed in step modal form.

The default implementation of this method is to always return true.
You can provide a custom FormHandler to override this behavior.

See jcore/doStepButtons.jspf for use of this method.

Returns:

true to display the "Cancel" button, false to hide it

Since:

jcms-7.1.2 jcms-7.2 as requested by issue JCMS-3057

showNextButton

public boolean showNextButton()

Check if the "Next" button should be displayed in step modal form.

The default implementation of this method is to return true unless the finish button is being displayed by method showFinishButton().
You can provide a custom FormHandler to override this behavior.

See jcore/doStepButtons.jspf for use of this method.

Returns:

true to display the "Next" button, false to hide it

showPreviousButton

public boolean showPreviousButton()

Check if the "Previous" button should be displayed in step modal form.

The default implementation of this method is to return true if the current step (as returned by getFormStep() is higher than 0.
You can provide a custom FormHandler to override this behavior.

See jcore/doStepButtons.jspf for use of this method.

Returns:

true to display the "Previous" button, false to hide it

showFinishButton

public boolean showFinishButton()

Check if the "Finish" button should be displayed in step modal form.

The default implementation of this method is to return true if the current step (as returned by getFormStep() is the last one (as compared with getFormStepCount().
You can provide a custom FormHandler to override this behavior.

See jcore/doStepButtons.jspf for use of this method.

Returns:

true to display the "Finish" button, false to hide it

getFormStepCount

public int getFormStepCount()

Retrieve the total number of steps used for edition when invoking this form handler.

The default implementation of this method is to return 1, corresponding to one step (which means only 1 screen being displayed).
You can provide a custom FormHandler to override this behavior.

See jcore/doSteps.jspf for use of this method.

Returns:

the total number of steps in this formhandler

getFormStep

public int getFormStep()

Retrieve the current step of edition when invoking this form handler.

See jcore/doSteps.jspf for use of this method.

Returns:

the current steps in this formhandler (starting at 0 and ending at getFormStepCount() - 1)

setFormStep

public void setFormStep(int step)

Set the current step of edition when invoking this form handler.

Parameters:

step - the current step (0 being the first one and getFormStepCount() - 1 being the last one)

setExtraKeys

public void setExtraKeys(java.lang.String[] extraKeys)

Convenient methods to update ExtraDataMap from bean

Parameters:

extraKeys - the extraKey

Since:

jcms-5.7.1

setExtraValues

public void setExtraValues(java.lang.String[] extraValues)

Convenient methods to update ExtraDataMap from bean

Parameters:

extraValues - the extraValues

Since:

jcms-5.7.1

getAvailableExtraDataMap

public java.util.Map<java.lang.String,java.lang.String> getAvailableExtraDataMap()

Returns a Map of available extra data. A mix between:

1. Default extra data
2. Previous extra data
3. Submited extra data

Returns:

Map of extra data

setExtraDBKeys

public void setExtraDBKeys(java.lang.String[] extraDBKeys)

Convenient methods to update ExtraDBDataMap from bean

Parameters:

extraDBKeys - the extraDBKey

Since:

jcms-6.0

setExtraDBValues

public void setExtraDBValues(java.lang.String[] extraDBValues)

Convenient methods to update ExtraDBDataMap from bean

Parameters:

extraDBValues - the extraDBValues

Since:

jcms-6.0

getAvailableExtraDBDataMap

public java.util.Map<java.lang.String,java.lang.String> getAvailableExtraDBDataMap()

Returns a Map of available extra db data. A mix between:

1. Default extra db data
2. Previous extra db data
3. Submited extra db data

Returns:

Map of extra db data

Since:

jcms-6.0

processDataIds

protected <T extends Data> java.util.List<T> processDataIds(java.lang.String fieldName,
                                                java.lang.String[] ids,
                                                java.lang.Class<T> clazz)

Computes link array to retrieve Data of the given Class. Trim end of the returned List. If link array contains value MultipartRequest.MULTIPART_UPLOAD then instanciate a new FileDocument but do NOT perform create. Handler.validate() should perform Create or Update. Underlaying files are never overrided.

Type Parameters:

T - The data type

Parameters:

fieldName - the field name

ids - arrays of ids

clazz - the class of links

Returns:

List a list of Data

Since:

jcms-5.7.0

processDataIds

protected <T extends Data> java.util.List<T> processDataIds(java.lang.String fieldName,
                                                java.lang.String[] ids,
                                                java.lang.Class<T> clazz,
                                                boolean trim)

Computes link array to retrieve Data of the given Class. Optionnaly, trims the end of the returned List. If link array contains value MultipartRequest.MULTIPART_UPLOAD then instanciate a new FileDocument but do NOT perform create. Handler.validate() should perform Create or Update. Underlaying files are never overrided.

Type Parameters:

T - The data type

Parameters:

fieldName - the field name

ids - arrays of ids

clazz - the class of links

trim - if true, trim the end of the returned list.

Returns:

List a list of Data

Since:

jcms-6.0.0

processDataId

protected Data processDataId(java.lang.String fieldName,
                 java.lang.String dataId,
                 java.lang.Class<? extends Data> clazz)

Computes given dataid, trim and retrieve associated data. If link contains value MultipartRequest.MULTIPART_UPLOAD then instanciate a new FileDocument but do NOT perform create. Handler.validate() should perform Create or Update. Underlaying files are never overrided. Check the data match the given class.

Parameters:

fieldName - The field name

dataId - the id of the data

clazz - the class of the data

Returns:

Data the updated data

Since:

jcms-5.7.0

validateUploadedFileDocument

protected boolean validateUploadedFileDocument(Data data,
                                   Member author,
                                   Workspace ws)

Performs create on given data if it is a FileDocument that have just been uploaded. This method should be called by EditPublicationHandler#validateBeforeOp()

Parameters:

data - the data to work with

author - the author of the data

ws - the workspace of the data

Returns:

true if ControllerStatus is ok

Since:

jcms-5.7.0

See Also:

EditPublicationHandler.validateBeforeOp()

validateUploadedFileDocument

protected boolean validateUploadedFileDocument(Data data,
                                   java.util.Map dataML,
                                   Member author,
                                   Workspace ws)

Performs create on given data if it is a FileDocument that have just been uploaded. This method should be called by EditPublicationHandler#validateBeforeOp()

Parameters:

data - the data to work with

dataML - the other languages

author - the author of the data

ws - the workspace of the data

Returns:

true if ControllerStatus is ok

Since:

jcms-6.1.3

See Also:

EditPublicationHandler.validateBeforeOp()

validateUploadedFileDocument

protected boolean validateUploadedFileDocument(Data[] datas,
                                   Member author,
                                   Workspace ws)

Performs validate on given array of data if it is a FileDocument that have just been uploaded. This method should be called by EditPublicationHandler#validateBeforeOp()

Parameters:

datas - an array of data to work with

author - the author of the data

ws - the workspace of the data

Returns:

true if ControllerStatus is ok

Since:

jcms-5.7.0

See Also:

EditPublicationHandler.validateBeforeOp()

validateUploadedFileDocument

protected boolean validateUploadedFileDocument(Data[] datas,
                                   java.util.Map dataML,
                                   Member author,
                                   Workspace ws)

Performs create on given data if it is a FileDocument that have just been uploaded. This method should be called by EditPublicationHandler#validateBeforeOp()

Parameters:

datas - an array of data to work with

dataML - the other languages

author - the author of the data

ws - the workspace of the data

Returns:

true if ControllerStatus is ok

Since:

jcms-6.1.3

See Also:

EditPublicationHandler.validateBeforeOp()

createUploadedFileDocument

protected boolean createUploadedFileDocument(Data data,
                                 Member author,
                                 Workspace ws)

Performs create on given data if it is a FileDocument that have just been uploaded. This method should be called by EditPublicationHandler#validateBeforeOp()

Parameters:

data - the data to work with

author - the author of the data

ws - the workspace of the data

Returns:

true if ControllerStatus is ok

Since:

jcms-5.7.0

See Also:

EditPublicationHandler.validateBeforeOp()

createUploadedFileDocument

protected boolean createUploadedFileDocument(Data data,
                                 java.util.Map dataML,
                                 Member author,
                                 Workspace ws)

Performs create on given array of data if it is a FileDocument that have just been uploaded. This method should be called by EditPublicationHandler#validateBeforeOp()

Parameters:

data - the data to work with (main language

dataML - the other languages

author - the author of the data

ws - the workspace of the data

Returns:

true if ControllerStatus is ok

Since:

jcms-6.1.3

See Also:

EditPublicationHandler.validateBeforeOp()

createUploadedFileDocument

protected boolean createUploadedFileDocument(Data[] datas,
                                 Member author,
                                 Workspace ws)

Performs create on given array of data if it is a FileDocument that have just been uploaded. This method should be called by EditPublicationHandler#validateBeforeOp()

Parameters:

datas - an array of data to work with

author - the author of the data

ws - the workspace of the data

Returns:

true if ControllerStatus is ok

Since:

jcms-6.1.2

See Also:

EditPublicationHandler.validateBeforeOp()

createUploadedFileDocument

protected boolean createUploadedFileDocument(Data[] datas,
                                 java.util.Map dataML,
                                 Member author,
                                 Workspace ws)

Performs create on given array of data if it is a FileDocument that have just been uploaded. This method should be called by EditPublicationHandler#validateBeforeOp()

Parameters:

datas - an array of data to work with

dataML - the other languages

author - the author of the data

ws - the workspace of the data

Returns:

true if ControllerStatus is ok

Since:

jcms-6.1.3

See Also:

EditPublicationHandler.validateBeforeOp()

processMLData

public Data processMLData(java.lang.String fieldName,
                 java.lang.Class clazz,
                 java.lang.String[] values,
                 java.util.Map mlMap)

Process the given ML values (data ids)

Parameters:

fieldName - the field name

clazz - the class

values - the ids

mlMap - the mlMap

Returns:

the data in the main language

Since:

jcms-5.7.0

processMLDataArray

public <T extends Data> Data[] processMLDataArray(java.lang.String fieldName,
                                         java.lang.Class<T> clazz,
                                         java.lang.String[] values,
                                         java.util.Map mlMap)

Process the given ML values (data ids)

Type Parameters:

T - The data type

Parameters:

fieldName - the field name

clazz - the class

values - the ids

mlMap - the mlMap

Returns:

the data array in the main language

Since:

jcms-5.7.0

getAvailableData

public Data getAvailableData(Data data,
                    Data dataField,
                    Data field,
                    java.util.Map mlMap,
                    java.lang.String lang)

Generic method to get available ML field for a given data in a given language.

Parameters:

data - the object (eg a Publication)

dataField - the current value of the field (may be null)

field - the proposed value for this field

mlMap - the ML map

lang - the langugage value

Returns:

the value for the field of the object in the given language

Since:

jcms-5.7.0

getAvailableDataArray

public Data[] getAvailableDataArray(Data data,
                           Data[] dataField,
                           Data[] field,
                           java.util.Map mlMap,
                           java.lang.String lang)

Generic method to get available ML field for a given array of data in a given language.

Parameters:

data - the object (eg a Publication)

dataField - the current value of the field (may be null)

field - the proposed value for this field

mlMap - the ML map

lang - the langugage value

Returns:

the value for the field of the object in the given language

Since:

jcms-5.7.0

isFirstAccess

public boolean isFirstAccess()

Returns true if this is the first access to this form (no previous submission).

Returns:

true if this is the first access to this form (no previous submission).

Since:

jcms-5.7.0

handleRestResponse

protected void handleRestResponse()
                           throws java.io.IOException

Throws:

java.io.IOException

restValidation

protected boolean restValidation(boolean result)
                          throws java.io.IOException

Throws:

java.io.IOException