org.alfresco.web.forms
Interface Form

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
FormImpl

public interface Form
extends java.io.Serializable

Encapsulation of a form.


Method Summary
 void addRenderingEngineTemplate(RenderingEngineTemplate output)
          adds an output method to this template type.
 org.alfresco.service.cmr.workflow.WorkflowDefinition getDefaultWorkflow()
           
 java.util.Map getDefaultWorkflowParameters()
           
 java.lang.String getDescription()
          the description of the form
 java.util.List getFormProcessors()
          Provides a set of input methods for this template.
 java.lang.String getName()
          the name of the form, which must be unique within the FormsService
 java.lang.String getOutputPathForFormInstanceData(org.w3c.dom.Document formInstanceData, java.lang.String formInstanceDataFileName, java.lang.String parentAVMPath, java.lang.String webappName)
          provides the output path for the form instance data based on the configured output path pattern.
 java.lang.String getOutputPathPattern()
          the output path pattern for form instance data
 RenderingEngineTemplate getRenderingEngineTemplate(java.lang.String name)
          Provides the rendering engine template by name.
 java.util.List getRenderingEngineTemplates()
          Provides the set of output methods for this template.
 org.w3c.dom.Document getSchema()
          the xml schema for this template type
 java.lang.String getSchemaRootElementName()
          the root tag to use within the schema
 java.lang.String getTitle()
          the title of the form
 boolean isWebForm()
           
 

Method Detail

getName

java.lang.String getName()
the name of the form, which must be unique within the FormsService


getTitle

java.lang.String getTitle()
the title of the form


getDescription

java.lang.String getDescription()
the description of the form


getSchemaRootElementName

java.lang.String getSchemaRootElementName()
the root tag to use within the schema


getOutputPathPattern

java.lang.String getOutputPathPattern()
the output path pattern for form instance data


getDefaultWorkflow

org.alfresco.service.cmr.workflow.WorkflowDefinition getDefaultWorkflow()
Returns:
the default workflow associated with this form or null if none is configured.

getDefaultWorkflowParameters

java.util.Map getDefaultWorkflowParameters()
Returns:
the parameters for the default workflow or null if none were configured.

getSchema

org.w3c.dom.Document getSchema()
                               throws java.io.IOException,
                                      org.xml.sax.SAXException
the xml schema for this template type

Throws:
java.io.IOException
org.xml.sax.SAXException

getOutputPathForFormInstanceData

java.lang.String getOutputPathForFormInstanceData(org.w3c.dom.Document formInstanceData,
                                                  java.lang.String formInstanceDataFileName,
                                                  java.lang.String parentAVMPath,
                                                  java.lang.String webappName)
provides the output path for the form instance data based on the configured output path pattern.

Parameters:
formInstanceData - the parsed xml content
formInstanceDataFileName - the file name provided by the user.
parentAVMPath - the parent avm path
webappName - the current webapp name
Returns:
the path to use for writing the form instance data.

getFormProcessors

java.util.List getFormProcessors()
Provides a set of input methods for this template.


addRenderingEngineTemplate

void addRenderingEngineTemplate(RenderingEngineTemplate output)
adds an output method to this template type.


getRenderingEngineTemplates

java.util.List getRenderingEngineTemplates()
Provides the set of output methods for this template.


getRenderingEngineTemplate

RenderingEngineTemplate getRenderingEngineTemplate(java.lang.String name)
Provides the rendering engine template by name.

Parameters:
name - the name of the rendering engine template.
Returns:
the rendering engine template or null if not found.

isWebForm

boolean isWebForm()
Returns:
true if WCM Form, false if ECM form


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.