org.alfresco.web.forms

Class FormsService

java.lang.Object

org.alfresco.web.forms.FormsService

public final class FormsService
extends java.lang.Object

Provides management of forms.

Constructor Summary

Constructors

Constructor and Description
FormsService(org.alfresco.service.cmr.repository.ContentService contentService, org.alfresco.service.cmr.repository.NodeService nodeService, org.alfresco.service.namespace.NamespaceService namespaceService, org.alfresco.service.cmr.search.SearchService searchService, org.alfresco.repo.policy.PolicyComponent policyComponent) instantiated using spring

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List	getAssociatedWebProjects(Form form)
org.alfresco.service.cmr.repository.NodeRef	getContentFormsNodeRef()
Form	getForm(org.alfresco.service.cmr.repository.NodeRef nodeRef) Returns the form backed by the given NodeRef.
Form	getForm(java.lang.String name) Deprecated.
FormInstanceData	getFormInstanceData(int version, java.lang.String avmPath)
FormInstanceData	getFormInstanceData(org.alfresco.service.cmr.repository.NodeRef nodeRef)
java.util.Collection	getForms() returns registered forms
RenderingEngine	getRenderingEngine(java.lang.String name) Returns the rendering engine with the given name.
RenderingEngine[]	getRenderingEngines() Provides all registered rendering engines.
Rendition	getRendition(int version, java.lang.String avmPath)
Rendition	getRendition(org.alfresco.service.cmr.repository.NodeRef nodeRef)
org.alfresco.service.cmr.repository.NodeRef	getWebContentFormsNodeRef()
Form	getWebForm(java.lang.String name) Deprecated.
java.util.Collection	getWebForms() returns registered web forms
RenderingEngine	guessRenderingEngine(java.lang.String fileName)
void	handleDeleteFormFolder(org.alfresco.service.cmr.repository.ChildAssociationRef childRef, boolean isArchivedNode)
void	handleMoveFormFolder(org.alfresco.service.cmr.repository.ChildAssociationRef oldChild, org.alfresco.service.cmr.repository.ChildAssociationRef newChild)

Methods inherited from class java.lang.Object

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

Constructor Detail

FormsService

public FormsService(org.alfresco.service.cmr.repository.ContentService contentService,
            org.alfresco.service.cmr.repository.NodeService nodeService,
            org.alfresco.service.namespace.NamespaceService namespaceService,
            org.alfresco.service.cmr.search.SearchService searchService,
            org.alfresco.repo.policy.PolicyComponent policyComponent)

instantiated using spring

Method Detail

getRenderingEngines

public RenderingEngine[] getRenderingEngines()

Provides all registered rendering engines.

getRenderingEngine

public RenderingEngine getRenderingEngine(java.lang.String name)

Returns the rendering engine with the given name.

Parameters:

name - the name of the rendering engine.

Returns:

the rendering engine or null if not found.

guessRenderingEngine

public RenderingEngine guessRenderingEngine(java.lang.String fileName)

getContentFormsNodeRef

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

Returns:

the cached reference to the WCM Content Forms folder

getWebContentFormsNodeRef

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

Returns:

the cached reference to the WCM Content Forms folder

getForms

public java.util.Collection getForms()

returns registered forms

Returns:

registered (ECM) forms

getWebForms

public java.util.Collection getWebForms()

returns registered web forms

Returns:

registered (WCM) forms

getForm

public Form getForm(java.lang.String name)
             throws FormNotFoundException

Deprecated.

return the form by name or null if not found

Returns:

the form by name or null if not found

Throws:

FormNotFoundException

getWebForm

public Form getWebForm(java.lang.String name)
                throws FormNotFoundException

Deprecated.

return the web form by name or null if not found

Returns:

the (WCM) form by name or null if not found

Throws:

FormNotFoundException

getForm

public Form getForm(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Returns the form backed by the given NodeRef. The NodeRef should point to the schema for this form.

Parameters:

nodeRef - the node ref for the schema for the form

Returns:

the form for the given node ref.

getFormInstanceData

public FormInstanceData getFormInstanceData(int version,
                                   java.lang.String avmPath)
                                     throws FormNotFoundException

Throws:

FormNotFoundException

getFormInstanceData

public FormInstanceData getFormInstanceData(org.alfresco.service.cmr.repository.NodeRef nodeRef)
                                     throws FormNotFoundException

Throws:

FormNotFoundException

getRendition

public Rendition getRendition(int version,
                     java.lang.String avmPath)

getRendition

public Rendition getRendition(org.alfresco.service.cmr.repository.NodeRef nodeRef)

getAssociatedWebProjects

public java.util.List getAssociatedWebProjects(Form form)

handleMoveFormFolder

public void handleMoveFormFolder(org.alfresco.service.cmr.repository.ChildAssociationRef oldChild,
                        org.alfresco.service.cmr.repository.ChildAssociationRef newChild)

handleDeleteFormFolder

public void handleDeleteFormFolder(org.alfresco.service.cmr.repository.ChildAssociationRef childRef,
                          boolean isArchivedNode)