Files
alfresco-community-repo/source/java/org/alfresco/web/forms/Rendition.java
Ariel Backenroth a25d85ee83 - moving generic xml parsing utilities out of FormsService and into their own class
- refactoring to generate and regenerate methods to make it easier to use project level overridden properties, and to at some point (soon) make it possible to make error handling for rendering engines more robust
- added a web project object to encapsulate web project properties and provide a central location for getting forms and rendering engines with web project level overridden properties
- made select default workflow screen match wireframes
- using the same workflowdefault type in the wcm model for web projects and forms.
- using outputpathpattern aspect consistently
- using commons.io to parse paths
- using form name rather than noderef as parameter for selected form from content forms dashlet
- fixed bug where rendition properties noderef wasn't being properly associated with renditions causing problems with regenerate
- using multivalued properties to track renditions
- remove weird registerRendition/registerFormInstanceData calls.  no longer necessary since generateRendition and regenerate are done within forminstancedata and rendition
- adding default workflow parameters as property of Form
- adding a unique name property to rendering engine templates to allow for looking one up by name


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@4702 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2006-12-31 08:45:42 +00:00

75 lines
2.2 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 java.io.IOException;
import java.io.OutputStream;
import java.io.Serializable;
import org.alfresco.service.cmr.repository.NodeRef;
import org.xml.sax.SAXException;
/**
* Encapsulation of a rendition.
*
* @author Ariel Backenroth
*/
public interface Rendition
extends Serializable
{
/** the name of this rendition */
public String getName();
/** the description of this rendition */
public String getDescription();
/** the path relative to the containing webapp */
public String getWebappRelativePath();
/** the path relative to the sandbox */
public String getSandboxRelativePath();
/** the primary form instance data used to generate this rendition */
public FormInstanceData getPrimaryFormInstanceData();
/** the rendering engine template that generated this rendition */
public RenderingEngineTemplate getRenderingEngineTemplate();
/** the path to the contents of this rendition */
public String getPath();
/** the url to the asset */
public String getUrl();
/** the file type image for the rendition */
public String getFileTypeImage();
/** the output stream for the rendition */
public OutputStream getOutputStream();
/** regenerates the contents of this rendition using the primary form instance data */
public void regenerate()
throws IOException,
RenderingEngine.RenderingException,
SAXException;
/** regenerates the contents of this rendition using the provided form instance data*/
public void regenerate(final FormInstanceData formInstanceData)
throws IOException,
RenderingEngine.RenderingException,
SAXException;
}