org.alfresco.web.forms
Class FormImpl

java.lang.Object
  extended by org.alfresco.web.forms.FormImpl
All Implemented Interfaces:
java.io.Serializable, Form

public class FormImpl
extends java.lang.Object
implements Form

See Also:
Serialized Form

Constructor Summary
protected FormImpl(org.alfresco.service.cmr.repository.NodeRef folderNodeRef, FormsService formsService)
           
 
Method Summary
 void addRenderingEngineTemplate(RenderingEngineTemplate ret)
          adds an output method to this template type.
 boolean equals(java.lang.Object other)
           
 org.alfresco.service.cmr.workflow.WorkflowDefinition getDefaultWorkflow()
           
protected  org.alfresco.service.cmr.repository.NodeRef getDefaultWorkflowNodeRef()
           
 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.
protected  FormsService getFormsService()
           
 java.lang.String getName()
          the name of the form, which must be unique within the FormsService
 org.alfresco.service.cmr.repository.NodeRef getNodeRef()
           
 java.lang.String getOutputPathForFormInstanceData(org.w3c.dom.Document formInstanceData, java.lang.String formInstanceDataName, 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
protected  org.alfresco.service.ServiceRegistry getServiceRegistry()
           
 java.lang.String getTitle()
          the title of the form
 int hashCode()
           
 boolean isWebForm()
           
protected  java.util.Map loadRenderingEngineTemplates()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FormImpl

protected FormImpl(org.alfresco.service.cmr.repository.NodeRef folderNodeRef,
                   FormsService formsService)
Method Detail

getFormsService

protected FormsService getFormsService()

getName

public java.lang.String getName()
Description copied from interface: Form
the name of the form, which must be unique within the FormsService

Specified by:
getName in interface Form

getTitle

public java.lang.String getTitle()
Description copied from interface: Form
the title of the form

Specified by:
getTitle in interface Form

getDescription

public java.lang.String getDescription()
Description copied from interface: Form
the description of the form

Specified by:
getDescription in interface Form

getOutputPathPattern

public java.lang.String getOutputPathPattern()
Description copied from interface: Form
the output path pattern for form instance data

Specified by:
getOutputPathPattern in interface Form

getDefaultWorkflow

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

getDefaultWorkflowParameters

public java.util.Map getDefaultWorkflowParameters()
Specified by:
getDefaultWorkflowParameters in interface Form
Returns:
the parameters for the default workflow or null if none were configured.

getDefaultWorkflowNodeRef

protected org.alfresco.service.cmr.repository.NodeRef getDefaultWorkflowNodeRef()

getOutputPathForFormInstanceData

public java.lang.String getOutputPathForFormInstanceData(org.w3c.dom.Document formInstanceData,
                                                         java.lang.String formInstanceDataName,
                                                         java.lang.String parentAVMPath,
                                                         java.lang.String webappName)
Description copied from interface: Form
provides the output path for the form instance data based on the configured output path pattern.

Specified by:
getOutputPathForFormInstanceData in interface Form
Parameters:
formInstanceData - the parsed xml content
formInstanceDataName - 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.

getSchemaRootElementName

public java.lang.String getSchemaRootElementName()
Description copied from interface: Form
the root tag to use within the schema

Specified by:
getSchemaRootElementName in interface Form

getSchema

public org.w3c.dom.Document getSchema()
                               throws java.io.IOException,
                                      org.xml.sax.SAXException
Description copied from interface: Form
the xml schema for this template type

Specified by:
getSchema in interface Form
Throws:
java.io.IOException
org.xml.sax.SAXException

getFormProcessors

public java.util.List getFormProcessors()
Description copied from interface: Form
Provides a set of input methods for this template.

Specified by:
getFormProcessors in interface Form

addRenderingEngineTemplate

public void addRenderingEngineTemplate(RenderingEngineTemplate ret)
Description copied from interface: Form
adds an output method to this template type.

Specified by:
addRenderingEngineTemplate in interface Form

getRenderingEngineTemplates

public java.util.List getRenderingEngineTemplates()
Description copied from interface: Form
Provides the set of output methods for this template.

Specified by:
getRenderingEngineTemplates in interface Form

getRenderingEngineTemplate

public RenderingEngineTemplate getRenderingEngineTemplate(java.lang.String name)
Description copied from interface: Form
Provides the rendering engine template by name.

Specified by:
getRenderingEngineTemplate in interface Form
Parameters:
name - the name of the rendering engine template.
Returns:
the rendering engine template or null if not found.

getNodeRef

public org.alfresco.service.cmr.repository.NodeRef getNodeRef()

isWebForm

public boolean isWebForm()
Specified by:
isWebForm in interface Form
Returns:
true if WCM Form, false if ECM form

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

equals

public boolean equals(java.lang.Object other)
Overrides:
equals in class java.lang.Object

getServiceRegistry

protected org.alfresco.service.ServiceRegistry getServiceRegistry()

loadRenderingEngineTemplates

protected java.util.Map loadRenderingEngineTemplates()


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