public abstract class EditDataHandler extends JcmsFormHandler
Data
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 |
contextMap, editFieldSet, noRedirect, noSendRedirect, popupEdition, redirect, redirectOnClosePopup, workspaceForced
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
browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, workspace
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
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 and Description |
---|
EditDataHandler() |
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> |
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> |
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> |
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.
|
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
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, showEditIcon, workaroundBrowserBaseHrefBug
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
public static final java.lang.String REVISION
protected boolean op
protected boolean opCreate
protected boolean resultOpCreate
protected boolean opUpdate
protected boolean resultOpUpdate
protected boolean opDelete
protected boolean resultOpDelete
protected boolean opCancel
protected boolean opRefresh
protected boolean opPrevious
protected boolean opNext
protected boolean opFinish
protected java.lang.String id
protected EditTypeExtensionHandler extFormHandler
protected boolean isDeleteForced
protected int formStep
protected void sendRedirect() throws java.io.IOException
java.io.IOException
protected boolean afterValidation(boolean result) throws java.io.IOException
afterValidation
in class JcmsFormHandler
java.io.IOException
public boolean processAction() throws java.io.IOException
JcmsFormHandler
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.
processAction
in class JcmsFormHandler
java.io.IOException
protected boolean validatePrevious() throws java.io.IOException
java.io.IOException
protected boolean performPrevious() throws java.io.IOException
java.io.IOException
protected boolean validateNext() throws java.io.IOException
java.io.IOException
protected boolean performNext() throws java.io.IOException
java.io.IOException
protected boolean validateFinish() throws java.io.IOException
java.io.IOException
protected boolean performFinish() throws java.io.IOException
java.io.IOException
protected java.util.HashMap<java.lang.String,java.lang.Object> getControllerContext()
JcmsFormHandler
getControllerContext
in class JcmsFormHandler
public void setFields(Data data)
data
- the publication to set the fieldspublic abstract java.lang.Class<? extends Data> getDataClass()
protected boolean validateCreateExtension(Data extendedData) throws java.io.IOException
java.io.IOException
protected DataExtension performCreateExtension() throws java.io.IOException
java.io.IOException
protected boolean validateUpdateExtension(DataExtension extension, Data extendedData) throws java.io.IOException
java.io.IOException
protected DataExtension performUpdateExtension(DataExtension extension) throws java.io.IOException
java.io.IOException
public boolean validateCancel()
public boolean performCancel() throws java.io.IOException
java.io.IOException
public boolean validateRefresh()
public boolean performRefresh() throws java.io.IOException
java.io.IOException
public void setOpCreate(java.lang.String v)
public void setOpUpdate(java.lang.String v)
public void setOpDelete(java.lang.String v)
public void setOpCancel(java.lang.String v)
public void setOpRefresh(java.lang.String v)
public void setOpPrevious(java.lang.String v)
public void setOpNext(java.lang.String v)
public void setOpFinish(java.lang.String v)
public java.lang.String getId()
public void setId(java.lang.String id)
public void setForceDelete(java.lang.String v)
public EditTypeExtensionHandler getExtFormHandler()
public void setExtFormHandler(EditTypeExtensionHandler handler)
public boolean showCancelButton()
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.
public boolean showNextButton()
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.
public boolean showPreviousButton()
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.
public boolean showFinishButton()
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.
public int getFormStepCount()
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.
public int getFormStep()
See jcore/doSteps.jspf for use of this method.
getFormStepCount()
- 1
)public void setFormStep(int step)
step
- the current step (0 being the first one and getFormStepCount()
- 1
being the last one)public void setExtraKeys(java.lang.String[] extraKeys)
extraKeys
- the extraKeypublic void setExtraValues(java.lang.String[] extraValues)
extraValues
- the extraValuespublic java.util.Map<java.lang.String,java.lang.String> getAvailableExtraDataMap()
public void setExtraDBKeys(java.lang.String[] extraDBKeys)
extraDBKeys
- the extraDBKeypublic void setExtraDBValues(java.lang.String[] extraDBValues)
extraDBValues
- the extraDBValuespublic java.util.Map<java.lang.String,java.lang.String> getAvailableExtraDBDataMap()
protected <T extends Data> java.util.List<T> processDataIds(java.lang.String fieldName, java.lang.String[] ids, java.lang.Class<T> clazz)
T
- The data typefieldName
- the field nameids
- arrays of idsclazz
- the class of linksprotected <T extends Data> java.util.List<T> processDataIds(java.lang.String fieldName, java.lang.String[] ids, java.lang.Class<T> clazz, boolean trim)
T
- The data typefieldName
- the field nameids
- arrays of idsclazz
- the class of linkstrim
- if true, trim the end of the returned list.protected Data processDataId(java.lang.String fieldName, java.lang.String dataId, java.lang.Class<? extends Data> clazz)
fieldName
- The field namedataId
- the id of the dataclazz
- the class of the dataprotected boolean validateUploadedFileDocument(Data data, Member author, Workspace ws)
EditPublicationHandler#validateBeforeOp()
data
- the data to work withauthor
- the author of the dataws
- the workspace of the dataEditPublicationHandler.validateBeforeOp()
protected boolean validateUploadedFileDocument(Data data, java.util.Map dataML, Member author, Workspace ws)
EditPublicationHandler#validateBeforeOp()
data
- the data to work withdataML
- the other languagesauthor
- the author of the dataws
- the workspace of the dataEditPublicationHandler.validateBeforeOp()
protected boolean validateUploadedFileDocument(Data[] datas, Member author, Workspace ws)
EditPublicationHandler#validateBeforeOp()
datas
- an array of data to work withauthor
- the author of the dataws
- the workspace of the dataEditPublicationHandler.validateBeforeOp()
protected boolean validateUploadedFileDocument(Data[] datas, java.util.Map dataML, Member author, Workspace ws)
EditPublicationHandler#validateBeforeOp()
datas
- an array of data to work withdataML
- the other languagesauthor
- the author of the dataws
- the workspace of the dataEditPublicationHandler.validateBeforeOp()
protected boolean createUploadedFileDocument(Data data, Member author, Workspace ws)
EditPublicationHandler#validateBeforeOp()
data
- the data to work withauthor
- the author of the dataws
- the workspace of the dataEditPublicationHandler.validateBeforeOp()
protected boolean createUploadedFileDocument(Data data, java.util.Map dataML, Member author, Workspace ws)
EditPublicationHandler#validateBeforeOp()
data
- the data to work with (main languagedataML
- the other languagesauthor
- the author of the dataws
- the workspace of the dataEditPublicationHandler.validateBeforeOp()
protected boolean createUploadedFileDocument(Data[] datas, Member author, Workspace ws)
EditPublicationHandler#validateBeforeOp()
datas
- an array of data to work withauthor
- the author of the dataws
- the workspace of the dataEditPublicationHandler.validateBeforeOp()
protected boolean createUploadedFileDocument(Data[] datas, java.util.Map dataML, Member author, Workspace ws)
EditPublicationHandler#validateBeforeOp()
datas
- an array of data to work withdataML
- the other languagesauthor
- the author of the dataws
- the workspace of the dataEditPublicationHandler.validateBeforeOp()
public Data processMLData(java.lang.String fieldName, java.lang.Class clazz, java.lang.String[] values, java.util.Map mlMap)
fieldName
- the field nameclazz
- the classvalues
- the idsmlMap
- the mlMappublic <T extends Data> Data[] processMLDataArray(java.lang.String fieldName, java.lang.Class<T> clazz, java.lang.String[] values, java.util.Map mlMap)
T
- The data typefieldName
- the field nameclazz
- the classvalues
- the idsmlMap
- the mlMappublic Data getAvailableData(Data data, Data dataField, Data field, java.util.Map mlMap, java.lang.String lang)
data
- the object (eg a Publication)dataField
- the current value of the field (may be null)field
- the proposed value for this fieldmlMap
- the ML maplang
- the langugage valuepublic Data[] getAvailableDataArray(Data data, Data[] dataField, Data[] field, java.util.Map mlMap, java.lang.String lang)
data
- the object (eg a Publication)dataField
- the current value of the field (may be null)field
- the proposed value for this fieldmlMap
- the ML maplang
- the langugage valuepublic boolean isFirstAccess()
protected void handleRestResponse() throws java.io.IOException
java.io.IOException
protected boolean restValidation(boolean result) throws java.io.IOException
java.io.IOException
Copyright © 2001-2010 Jalios SA. All Rights Reserved.