org.alfresco.service.cmr.rendition
Interface RenditionDefinition
All Superinterfaces:
-
@org.alfresco.api.AlfrescoPublicApi
public interface RenditionDefinition
This class is used to fully specify a type of rendition. It specifies which
rendering engine will be used as well as the parameters that will be given to
that engine.
Every RenditionDefinition has a
renditionName attribute which
uniquely identifies it.
Author:
-
Nick Smith, Neil McErlean
| Method Summary |
org.alfresco.service.cmr.rendition.RenderCallback |
getCallback() This method gets the registered callback object for use with asynchronous renditions. |
|
getRenditionAssociationType() Returns the association type used to link the rendition to its parent node after it has been newly created. |
|
getRenditionName() |
|
getRenditionParent() Returns the node to which the rendition is linked when it is first created. |
void |
setCallback(org.alfresco.service.cmr.rendition.RenderCallback callback) This method sets a callback object for use in asynchronous renditions. |
void |
setRenditionAssociationType(QName renditionAssociationType) Sets the association type used to link the rendition to its parent node after it has been newly created. |
void |
setRenditionParent(NodeRef renditionParent) Sets the node to which the rendition is linked when it is first created. |
| Methods inherited from interface org.alfresco.service.cmr.action.Action |
| addActionCondition, addActionCondition, addParameterValues, getActionCondition, getActionConditions, getActionDefinitionName, getCompensatingAction, getCreatedDate, getCreator, getDescription, getExecuteAsychronously, getExecutionEndDate, getExecutionFailureMessage, getExecutionStartDate, getExecutionStatus, getModifiedDate, getModifier, getNodeRef, getTitle, getTrackStatus, hasActionConditions, indexOfActionCondition, removeActionCondition, removeAllActionConditions, setActionCondition, setCompensatingAction, setDescription, setExecuteAsynchronously, setTitle, setTrackStatus |
getRenditionName
-
Returns:
-
the name which uniquely identifies this rendition definition.
getRenditionParent
-
Returns the node to which the rendition is linked when it is first
created. Typically this location is only temporary temporary as the
rendition will be moved to a different location by the
RenditionService shortly after its creation.
Returns:
-
the renditionParent
setRenditionParent
void setRenditionParent(NodeRef renditionParent) -
Sets the node to which the rendition is linked when it is first created.
Typically this location is only temporary temporary as the rendition will
be moved to a different location by the
RenditionService shortly
after its creation.
Parameters:
-
renditionParent - the renditionParent to set
getRenditionAssociationType
QName getRenditionAssociationType() -
Returns the association type used to link the rendition to its parent
node after it has been newly created. Typically this association is only
temporary as the rendition will be moved to a different location by the
RenditionService shortly after its creation.
Returns:
-
the renditionAssociationType
setRenditionAssociationType
void setRenditionAssociationType(QName renditionAssociationType) -
Sets the association type used to link the rendition to its parent node
after it has been newly created. Typically this association is only
temporary as the rendition will be moved to a different location by the
RenditionService shortly after its creation.
Parameters:
-
renditionAssociationType - the renditionAssociationType to set
setCallback
void setCallback(org.alfresco.service.cmr.rendition.RenderCallback callback)
-
This method sets a callback object for use in asynchronous renditions. It is
this object that will be notified of the successful or unsuccessful completion
of these renditions.
Parameters:
-
callback - a callback object, which may be null.
getCallback
org.alfresco.service.cmr.rendition.RenderCallback getCallback()
-
This method gets the registered callback object for use with asynchronous
renditions.
Returns:
-
the callback object