mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-07 17:49:17 +00:00
cb5a882837
- adding freemarker expression for output path patterns - enabling using the same rendering engine template with multiple mime types - extracting rendering engine template from rendering engine to make moving to templateservice easier eventually git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/WCM-DEV2/root@4351 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
82 lines
2.3 KiB
Java
82 lines
2.3 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 form, which must be unique within the FormsService */
|
|
public String getName();
|
|
|
|
/** the description of the form */
|
|
public String getDescription();
|
|
|
|
/**
|
|
* 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.
|
|
* @deprecated i'd rather not expose this
|
|
*/
|
|
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 NodeRef formInstanceDataNodeRef);
|
|
|
|
/**
|
|
* 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 NodeRef rendition, final NodeRef primaryFormInstanceData);
|
|
}
|