Package org.opencms.ugc

Class CmsUgcActionElement

java.lang.Object

org.opencms.jsp.CmsJspBean

org.opencms.jsp.CmsJspActionElement

org.opencms.ugc.CmsUgcActionElement

public class CmsUgcActionElement
extends CmsJspActionElement

Form action element class for use in rendering user-generated content forms.

Field Summary

Fields inherited from class org.opencms.jsp.CmsJspActionElement

NOT_INITIALIZED

Constructor Summary

Constructors

Constructor	Description
CmsUgcActionElement(javax.servlet.jsp.PageContext pageContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
java.lang.String	createSessionForResource(java.lang.String configPath, java.lang.String fileName)	Creates a new form session to edit the file with the given name using the given form configuration.

Methods inherited from class org.opencms.jsp.CmsJspActionElement

editable, editable, editable, editableManualClose, editableManualOpen, getContent, getContent, getMessages, getMessages, getMessages, getMessages, getNavigation, getNavigationUri, img, img, include, include, include, include, include, include, includeSilent, includeSilent, includeSilent, includeSilent, info, label, link, link, properties, properties, property, property, property, property, template, template, template, toAbsolute, user

Methods inherited from class org.opencms.jsp.CmsJspBean

getCmsObject, getController, getJspContext, getMessage, getRequest, getRequestContext, getResponse, handleException, handleMissingFlexController, init, isNotInitialized, isSupressingExceptions, setContentType, setStatus, setSupressingExceptions

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsUgcActionElement

public CmsUgcActionElement(javax.servlet.jsp.PageContext pageContext,
                           javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)

Creates a new instance.

Parameters:

pageContext - the JSP page context

request - the current request

response - the current response

Method Detail

createSessionForResource

public java.lang.String createSessionForResource(java.lang.String configPath,
                                                 java.lang.String fileName)
                                          throws CmsUgcException

Creates a new form session to edit the file with the given name using the given form configuration.

Parameters:

configPath - the site path of the form configuration

fileName - the name (not path) of the XML content to edit

Returns:

the id of the newly created form session

Throws:

CmsUgcException - if something goes wrong