Files
alfresco-community-repo/source/java/org/alfresco/web/forms/RenderingEngineTemplate.java
Ariel Backenroth 2190c4f29d - adding aspect to webapp nodes to differentiate them from ordinary folders in the avm_webapps directory
- refactoring of generate and regenerate calls to take a FormInstanceData object
- adding in support for overriding step title and description properties in wizards so as to be able to format them with parameters
- making the step descriptions in create form wizard reiterate the form name so as to give the user better context
- displaying avm task resources in the manage task screen.  still need to get actions working and clean this up a bit.
- making output path patterns sandbox relative
- refactored utility method for combining avm paths sensitive to webapp vs sandbox relative paths.
- adding a default description for generated renditions

todo:
- cleanup some usage of AVMNode from ManageTaskBean
- get actions to appear in manage task screen
- add a multi value property to the web project for all its webapps
- properly use overridden values for forms from the web project settings

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@4687 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2006-12-21 20:34:00 +00:00

88 lines
2.5 KiB
Java

/*
* Copyright (C) 2005 Alfresco, Inc.
*
* Licensed under the Mozilla Public License version 1.1
* with a permitted attribution clause. You may obtain a
* copy of the License at
*
* http://www.alfresco.org/legal/license.txt
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the
* License.
*/
package org.alfresco.web.forms;
import org.alfresco.service.cmr.repository.NodeRef;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Serializable;
import java.util.Map;
import org.w3c.dom.Document;
/**
* Describes a template that is used for rendering form instance data.
*
* @author Ariel Backenroth
*/
public interface RenderingEngineTemplate
extends Serializable
{
/** the name of the rendering engine template */
public String getName();
/** the title of the rendering engine template */
public String getTitle();
/** the description of the rendering engine template */
public String getDescription();
/** the output path pattern for renditions */
public String getOutputPathPattern();
/**
* Provides the rendering engine to use to process this template.
*
* @return the rendering engine to use to process this template.
*/
public RenderingEngine getRenderingEngine();
/**
* Provides the noderef for this template.
*
* @return the noderef for this template.
*/
public NodeRef getNodeRef();
/**
* Provides an input stream to the rendering engine template.
*
* @return the input stream to the rendering engine template.
*/
public InputStream getInputStream()
throws IOException;
/**
* Returns the output path for the rendition.
*
* @return the output path for the rendition.
*/
public String getOutputPathForRendition(final FormInstanceData formInstanceData);
/**
* Returns the mimetype to use when generating content for this
* output method.
*
* @return the mimetype to use when generating content for this
* output method, such as text/html, text/xml, application/pdf.
*/
public String getMimetypeForRendition();
public void registerRendition(final Rendition rendition,
final FormInstanceData primaryFormInstanceData);
}