org.opencms.workplace.editors.directedit

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 and 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 and Description
CmsDateSeriesEditHandler()

Method Summary

Modifier and Type	Method and 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.

Methods inherited from class java.lang.Object

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

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 interface I_CmsEditHandler

Parameters:

cms - the cms context

elementBean - the container element to be deleted

pageContextId - the structure id of the context containerpage

requestParams - 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 interface I_CmsEditHandler

Parameters:

cms - the cms context

elementBean - the container element to be edited

pageContextId - the structure id of the context containerpage

requestParams - the request parameters

isListElement - 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 interface I_CmsEditHandler

Parameters:

cms - the cms context

elementBean - the container element bean from which the 'New' operation was initiated

pageContextId - the structure id of the container page

requestParam - 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 interface I_CmsEditHandler

Parameters:

cms - the cms context

elementBean - the container element to delete

deleteOption - the selected delete option

pageContextId - the structure id of the context containerpage

requestParams - 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 interface I_CmsEditHandler

Parameters:

cms - The CmsObject of the current request

newLink - A string, specifying where which new content should be created.

locale - The locale

referenceSitePath - site path of the currently edited content.

modelFileSitePath - site path of the model file

postCreateHandler - optional class name of an I_CmsCollectorPostCreateHandler which is invoked after the content has been created.

element - the container element bean

pageId - the page id

requestParams - the request parameters

choice - 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 interface I_CmsEditHandler

Parameters:

cms - the cms context

elementBean - the container element to be edited

editOption - the selected edit option

pageContextId - the structure id of the context containerpage

requestParams - 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 interface I_CmsEditHandler

Parameters:

params - the parameters

See Also:

I_CmsEditHandler.setParameters(java.util.Map)