@AlfrescoPublicApi public interface RenditionService extends RenditionDefinitionPersister
Modifier and Type | Field and Description |
---|---|
static String |
PARAM_DESTINATION_NODE
This optional
NodeRef parameter specifies an existing NodeRef to use
as the rendition node. |
static String |
PARAM_DESTINATION_PATH_TEMPLATE
This optional
String parameter indicates where the rendition will be
created. |
static String |
PARAM_IS_COMPONENT_RENDITION
This optional boolean parameter specified whether the rendition is a component within
a composite rendition.
|
static String |
PARAM_ORPHAN_EXISTING_RENDITION
This optional
Boolean flag parameter determines whether an
existing rendition is moved or orphaned. |
static String |
PARAM_RENDITION_NODETYPE
This optional
QName parameter specifies what the node type of the created rendition will
be. |
Modifier and Type | Method and Description |
---|---|
void |
cancelRenditions(org.alfresco.service.cmr.repository.NodeRef sourceNode)
Cancels all known cancellable running renditions for the given
NodeRef via the ActionTrackingService . |
void |
cancelRenditions(org.alfresco.service.cmr.repository.NodeRef sourceNode,
String type)
Cancels all known cancellable running renditions for the given
NodeRef and type via the ActionTrackingService . |
CompositeRenditionDefinition |
createCompositeRenditionDefinition(org.alfresco.service.namespace.QName renditionName)
Creates a new
CompositeRenditionDefinition and sets the rendition
name and the rendering engine name to the specified values. |
RenditionDefinition |
createRenditionDefinition(org.alfresco.service.namespace.QName renditionName,
String renderingEngineName)
Creates a new
RenditionDefinition and sets the rendition name and
the rendering engine name to the specified values. |
RenderingEngineDefinition |
getRenderingEngineDefinition(String name)
Returns the
RenderingEngineDefinition associated with the
specified rendering engine name. |
List<RenderingEngineDefinition> |
getRenderingEngineDefinitions() |
org.alfresco.service.cmr.repository.ChildAssociationRef |
getRenditionByName(org.alfresco.service.cmr.repository.NodeRef node,
org.alfresco.service.namespace.QName renditionName)
This method gets the rendition of the specified node identified by
the provided rendition name.
|
List<org.alfresco.service.cmr.repository.ChildAssociationRef> |
getRenditions(org.alfresco.service.cmr.repository.NodeRef node)
This method gets all the renditions of the specified node.
|
List<org.alfresco.service.cmr.repository.ChildAssociationRef> |
getRenditions(org.alfresco.service.cmr.repository.NodeRef node,
String mimeTypePrefix)
This method gets all the renditions of the specified node filtered by
MIME-type prefix.
|
org.alfresco.service.cmr.repository.ChildAssociationRef |
getSourceNode(org.alfresco.service.cmr.repository.NodeRef renditionNode)
This method gets the source node for the specified rendition node.
|
boolean |
isRendition(org.alfresco.service.cmr.repository.NodeRef node)
This method returns
true if the specified NodeRef is a valid
rendition node, else false . |
org.alfresco.service.cmr.repository.ChildAssociationRef |
render(org.alfresco.service.cmr.repository.NodeRef sourceNode,
org.alfresco.service.namespace.QName renditionDefinitionQName)
This method synchronously renders content as specified by the given
rendition name . |
void |
render(org.alfresco.service.cmr.repository.NodeRef sourceNode,
org.alfresco.service.namespace.QName renditionDefinitionQName,
RenderCallback callback)
This method asynchronously renders content as specified by the given
rendition definition name . |
org.alfresco.service.cmr.repository.ChildAssociationRef |
render(org.alfresco.service.cmr.repository.NodeRef sourceNode,
RenditionDefinition renditionDefinition)
This method synchronously renders content as specified by the given
RenditionDefinition . |
void |
render(org.alfresco.service.cmr.repository.NodeRef sourceNode,
RenditionDefinition renditionDefinition,
RenderCallback callback)
This method asynchronously renders content as specified by the given
RenditionDefinition . |
loadRenditionDefinition, loadRenditionDefinitions, loadRenditionDefinitions, saveRenditionDefinition
static final String PARAM_DESTINATION_NODE
NodeRef
parameter specifies an existing 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.static final String PARAM_DESTINATION_PATH_TEMPLATE
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.static final String PARAM_RENDITION_NODETYPE
QName
parameter specifies what the node type of the created rendition will
be. If no type is specified then this defaults to cm:content.static final String PARAM_ORPHAN_EXISTING_RENDITION
Boolean
flag parameter determines whether an
existing rendition is moved or orphaned. If the source node already has a
rendition and this parameter is false
the old rendition will
be moved to the new destination location and updated appropriately. If
this parameter is set to true
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.static final String PARAM_IS_COMPONENT_RENDITION
@NotAuditable RenderingEngineDefinition getRenderingEngineDefinition(String name)
RenderingEngineDefinition
associated with the
specified rendering engine name.name
- The rendering engine name.RenderingEngineDefinition
or null.@NotAuditable List<RenderingEngineDefinition> getRenderingEngineDefinitions()
List
of all available RenderingEngineDefinition
s.@NotAuditable RenditionDefinition createRenditionDefinition(org.alfresco.service.namespace.QName renditionName, String renderingEngineName)
RenditionDefinition
and sets the rendition name and
the rendering engine name to the specified values.renditionName
- A unique identifier used to specify the created
RenditionDefinition
.renderingEngineName
- The name of the rendering engine associated
with this RenditionDefinition
.RenditionDefinition
.@NotAuditable CompositeRenditionDefinition createCompositeRenditionDefinition(org.alfresco.service.namespace.QName renditionName)
CompositeRenditionDefinition
and sets the rendition
name and the rendering engine name to the specified values.renditionName
- A unique identifier used to specify the created
RenditionDefinition
.CompositeRenditionDefinition
.@NotAuditable List<org.alfresco.service.cmr.repository.ChildAssociationRef> getRenditions(org.alfresco.service.cmr.repository.NodeRef node)
@NotAuditable List<org.alfresco.service.cmr.repository.ChildAssociationRef> getRenditions(org.alfresco.service.cmr.repository.NodeRef node, String mimeTypePrefix)
node
- the source node for the renditionsmimeTypePrefix
- a prefix to check against the rendition MIME-types.
This must not be null and must not be an empty String@NotAuditable org.alfresco.service.cmr.repository.ChildAssociationRef getRenditionByName(org.alfresco.service.cmr.repository.NodeRef node, org.alfresco.service.namespace.QName renditionName)
node
- the source node for the renditionsrenditionName
- the renditionName used to identify a rendition.null
if there is no such rendition.@NotAuditable boolean isRendition(org.alfresco.service.cmr.repository.NodeRef node)
true
if the specified NodeRef is a valid
rendition node, else false
. A nodeRef is a rendition node
if it has the rn:rendition aspect (or sub-aspect) applied.node
- NodeReftrue
if a rendition, else false
@NotAuditable org.alfresco.service.cmr.repository.ChildAssociationRef getSourceNode(org.alfresco.service.cmr.repository.NodeRef renditionNode)
renditionNode
- the nodeRef holding the rendition.null
if there is no source node.isRendition(NodeRef)
@NotAuditable org.alfresco.service.cmr.repository.ChildAssociationRef render(org.alfresco.service.cmr.repository.NodeRef sourceNode, RenditionDefinition renditionDefinition)
RenditionDefinition
. The content to be rendered is provided by
the specified source node.sourceNode
- the node from which the content is retrieved.renditionDefinition
- this fully specifies the rendition which is to
be performed.RenditionServiceException
- if there is a problem in rendering the
given sourceNode@NotAuditable void render(org.alfresco.service.cmr.repository.NodeRef sourceNode, RenditionDefinition renditionDefinition, RenderCallback callback)
RenditionDefinition
. The content to be rendered is provided by
the specified source node.sourceNode
- the node from which the content is retrieved.renditionDefinition
- this fully specifies the rendition which is to
be performed.callback
- a callback object to handle the ultimate result of the rendition.@NotAuditable org.alfresco.service.cmr.repository.ChildAssociationRef render(org.alfresco.service.cmr.repository.NodeRef sourceNode, org.alfresco.service.namespace.QName renditionDefinitionQName)
rendition name
.
The content to be rendered is provided by the specified source node.
The Rendition Definition will be loaded from the standard location as system
thus allowing rendition definitions to be used even when the Data Dictionary
has restricted read access.sourceNode
- the node from which the content is retrieved.renditionDefinitionQName
- the rendition definition which is to
be performed.RenditionServiceException
- if there is a problem in rendering the
given sourceNode@NotAuditable void render(org.alfresco.service.cmr.repository.NodeRef sourceNode, org.alfresco.service.namespace.QName renditionDefinitionQName, RenderCallback callback)
rendition definition name
.
The content to be rendered is provided by the specified source node.
The Rendition Definition will be loaded from the standard location as system
thus allowing rendition definitions to be used even when the Data Dictionary
has restricted read access.sourceNode
- the node from which the content is retrieved.renditionDefinitionQName
- the rendition definition which is to
be performed.callback
- a callback object to handle the ultimate result of the rendition.@NotAuditable void cancelRenditions(org.alfresco.service.cmr.repository.NodeRef sourceNode)
NodeRef
via the ActionTrackingService
.sourceNode
- the NodeRef
the action is acting on@NotAuditable void cancelRenditions(org.alfresco.service.cmr.repository.NodeRef sourceNode, String type)
NodeRef
and type via the ActionTrackingService
.sourceNode
- the NodeRef
the action is acting ontype
- the rendition type (rending engine name)Copyright © 2005–2017 Alfresco Software. All rights reserved.