inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-08-07 17:49:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added Javadoc to various RenditionService parameter constants.

Browse Source 
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@19230 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
N Smith
2010-03-11 16:00:13 +00:00
parent c36fe6b6c0
commit 5a2d92ed5d
5 changed files with 276 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
source/java/org/alfresco/service/cmr/rendition/RenditionService.java
View File

@@ -32,9 +32,40 @@ import org.alfresco.service.namespace.QName;
*/
public interface RenditionService extends RenditionDefinitionPersister
{
/**
* This optional {@link NodeRef} parameter specifies an existing {@link NodeRef} to use
* as the rendition node. Properties on this node (including the content
* property cm:content) will be updated as required but the location and
* name of the node will not change. This parameter takes precedence over
* PARAM_DESTINATION_PATH_TEMPLATE.
*/
public static final String PARAM_DESTINATION_NODE = "rendition-destination-node";
/**
* This optional {@link String} parameter indicates where the rendition will be
* created. The parameter may specify either the actual file path to the
* rendition or it may specify a Freemarker template which can be resolved
* to a file path. In either case the path is relative to the root node of
* the store in which the source node exists. If the parameter
* PARAM_DESTINATION_NODE has been set then this parameter will be ignored.
*/
public static final String PARAM_DESTINATION_PATH_TEMPLATE = "destination-path-template";
/**
* This optional {@link QName} parameter specifies what the node type of the created rendition will
* be. If no type is specified then this defaults to cm:content.
*/
public static final String PARAM_RENDITION_NODETYPE = "rendition-nodetype";
/**
* This optional {@link Boolean} flag parameter determines whether an
* existing rendition is moved or orphaned. If the source node already has a
* rendition and this parameter is <code>false</code> the old rendition will
* be moved to the new destination location and updated appropriately. If
* this parameter is set to <code>true</code> then the old rendition will be
* left in its current location and the rold rendition association from the
* source node to the old rendition will be deleted.
*/
public static final String PARAM_ORPHAN_EXISTING_RENDITION = "orphan-existing-rendition";
/**