Class CmsDateSeriesEditHandler
- java.lang.Object
-
- org.opencms.workplace.editors.directedit.CmsDateSeriesEditHandler
-
- All Implemented Interfaces:
I_CmsEditHandler
public class CmsDateSeriesEditHandler extends java.lang.Object implements I_CmsEditHandler
Special edit handler for contents that define multiple instances in a date series.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
PARAM_INSTANCEDATE
The key of the parameter/setting the instance date of the instance that should be edited is read from.
-
Constructor Summary
Constructors Constructor Description CmsDateSeriesEditHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CmsDialogOptions
getDeleteOptions(CmsObject cms, CmsContainerElementBean elementBean, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams)
Returns a map of delete options.CmsDialogOptions
getEditOptions(CmsObject cms, CmsContainerElementBean elementBean, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams, boolean isListElement)
Returns a map of edit options.CmsDialogOptions
getNewOptions(CmsObject cms, CmsContainerElementBean elementBean, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParam)
Gets the options for the 'New' (plus) operation in the page editor.void
handleDelete(CmsObject cms, CmsContainerElementBean elementBean, java.lang.String deleteOption, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams)
Executes the actual delete.java.lang.String
handleNew(CmsObject cms, java.lang.String newLink, java.util.Locale locale, java.lang.String referenceSitePath, java.lang.String modelFileSitePath, java.lang.String postCreateHandler, CmsContainerElementBean element, CmsUUID pageId, java.util.Map<java.lang.String,java.lang.String[]> requestParams, java.lang.String choice)
Creates a new resource to edit.CmsUUID
prepareForEdit(CmsObject cms, CmsContainerElementBean elementBean, java.lang.String editOption, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams)
Prepares the resource to be edited.void
setParameters(java.util.Map<java.lang.String,java.lang.String> params)
Sets parameters for the edit handler.
-
-
-
Field Detail
-
PARAM_INSTANCEDATE
public static final java.lang.String PARAM_INSTANCEDATE
The key of the parameter/setting the instance date of the instance that should be edited is read from.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsDateSeriesEditHandler
public CmsDateSeriesEditHandler()
-
-
Method Detail
-
getDeleteOptions
public CmsDialogOptions getDeleteOptions(CmsObject cms, CmsContainerElementBean elementBean, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams)
Description copied from interface:I_CmsEditHandler
Returns a map of delete options. The value being the option description displayed to the user.- Specified by:
getDeleteOptions
in interfaceI_CmsEditHandler
- Parameters:
cms
- the cms contextelementBean
- the container element to be deletedpageContextId
- the structure id of the context containerpagerequestParams
- the request parameters- Returns:
- the available delete options
- See Also:
I_CmsEditHandler.getDeleteOptions(org.opencms.file.CmsObject, org.opencms.xml.containerpage.CmsContainerElementBean, org.opencms.util.CmsUUID, java.util.Map)
-
getEditOptions
public CmsDialogOptions getEditOptions(CmsObject cms, CmsContainerElementBean elementBean, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams, boolean isListElement)
Description copied from interface:I_CmsEditHandler
Returns a map of edit options. The value being the option description displayed to the user.- Specified by:
getEditOptions
in interfaceI_CmsEditHandler
- Parameters:
cms
- the cms contextelementBean
- the container element to be editedpageContextId
- the structure id of the context containerpagerequestParams
- the request parametersisListElement
- in case a list element, not a container element is about to be edited- Returns:
- the available edit options
- See Also:
I_CmsEditHandler.getEditOptions(org.opencms.file.CmsObject, org.opencms.xml.containerpage.CmsContainerElementBean, org.opencms.util.CmsUUID, java.util.Map, boolean)
-
getNewOptions
public CmsDialogOptions getNewOptions(CmsObject cms, CmsContainerElementBean elementBean, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParam)
Description copied from interface:I_CmsEditHandler
Gets the options for the 'New' (plus) operation in the page editor.If this returns null, the default behavior for the 'New' operation will be used instead.
- Specified by:
getNewOptions
in interfaceI_CmsEditHandler
- Parameters:
cms
- the cms contextelementBean
- the container element bean from which the 'New' operation was initiatedpageContextId
- the structure id of the container pagerequestParam
- the request parameters- Returns:
- the available options, or null if the default behavior should be used
- See Also:
I_CmsEditHandler.getNewOptions(org.opencms.file.CmsObject, org.opencms.xml.containerpage.CmsContainerElementBean, org.opencms.util.CmsUUID, java.util.Map)
-
handleDelete
public void handleDelete(CmsObject cms, CmsContainerElementBean elementBean, java.lang.String deleteOption, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams) throws CmsException
Description copied from interface:I_CmsEditHandler
Executes the actual delete.- Specified by:
handleDelete
in interfaceI_CmsEditHandler
- Parameters:
cms
- the cms contextelementBean
- the container element to deletedeleteOption
- the selected delete optionpageContextId
- the structure id of the context containerpagerequestParams
- the request parameters- Throws:
CmsException
- if something goes wrong- See Also:
I_CmsEditHandler.handleDelete(org.opencms.file.CmsObject, org.opencms.xml.containerpage.CmsContainerElementBean, java.lang.String, org.opencms.util.CmsUUID, java.util.Map)
-
handleNew
public java.lang.String handleNew(CmsObject cms, java.lang.String newLink, java.util.Locale locale, java.lang.String referenceSitePath, java.lang.String modelFileSitePath, java.lang.String postCreateHandler, CmsContainerElementBean element, CmsUUID pageId, java.util.Map<java.lang.String,java.lang.String[]> requestParams, java.lang.String choice)
Description copied from interface:I_CmsEditHandler
Creates a new resource to edit.- Specified by:
handleNew
in interfaceI_CmsEditHandler
- Parameters:
cms
- The CmsObject of the current requestnewLink
- A string, specifying where which new content should be created.locale
- The localereferenceSitePath
- site path of the currently edited content.modelFileSitePath
- site path of the model filepostCreateHandler
- optional class name of anI_CmsCollectorPostCreateHandler
which is invoked after the content has been created.element
- the container element beanpageId
- the page idrequestParams
- the request parameterschoice
- the option chosen by the user- Returns:
- The site-path of the newly created resource.
- See Also:
I_CmsEditHandler.handleNew(org.opencms.file.CmsObject, java.lang.String, java.util.Locale, java.lang.String, java.lang.String, java.lang.String, org.opencms.xml.containerpage.CmsContainerElementBean, org.opencms.util.CmsUUID, java.util.Map, java.lang.String)
-
prepareForEdit
public CmsUUID prepareForEdit(CmsObject cms, CmsContainerElementBean elementBean, java.lang.String editOption, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams) throws CmsException
Description copied from interface:I_CmsEditHandler
Prepares the resource to be edited.- Specified by:
prepareForEdit
in interfaceI_CmsEditHandler
- Parameters:
cms
- the cms contextelementBean
- the container element to be editededitOption
- the selected edit optionpageContextId
- the structure id of the context containerpagerequestParams
- the request parameters- Returns:
- the structure id of the resource to be edited, may differ from the original element id
- Throws:
CmsException
- if something goes wrong- See Also:
I_CmsEditHandler.prepareForEdit(org.opencms.file.CmsObject, org.opencms.xml.containerpage.CmsContainerElementBean, java.lang.String, org.opencms.util.CmsUUID, java.util.Map)
-
setParameters
public void setParameters(java.util.Map<java.lang.String,java.lang.String> params)
Description copied from interface:I_CmsEditHandler
Sets parameters for the edit handler.- Specified by:
setParameters
in interfaceI_CmsEditHandler
- Parameters:
params
- the parameters- See Also:
I_CmsEditHandler.setParameters(java.util.Map)
-
-