org.alfresco.repo.rendition
Class RenditionDefinitionImpl

java.lang.Object
  extended by org.alfresco.repo.action.ParameterizedItemImpl
      extended by org.alfresco.repo.action.ActionImpl
          extended by org.alfresco.repo.rendition.RenditionDefinitionImpl
All Implemented Interfaces:
java.io.Serializable, Action, ParameterizedItem, RenditionDefinition
Direct Known Subclasses:
CompositeRenditionDefinitionImpl

public class RenditionDefinitionImpl
extends ActionImpl
implements RenditionDefinition

Since:
3.3
See Also:
Serialized Form

Field Summary
static java.lang.String RENDITION_DEFINITION_NAME
           
 org.alfresco.service.namespace.QName renditionAssociationType
           
 org.alfresco.service.cmr.repository.NodeRef renditionParent
           
 
Constructor Summary
RenditionDefinitionImpl(Action action)
           
RenditionDefinitionImpl(Action action, java.lang.String renderingEngineName)
           
RenditionDefinitionImpl(java.lang.String id, org.alfresco.service.namespace.QName renditionName, java.lang.String renderingEngineName)
           
 
Method Summary
 RenderCallback getCallback()
          This method gets the registered callback object for use with asynchronous renditions.
 org.alfresco.service.namespace.QName getRenditionAssociationType()
          Returns the association type used to link the rendition to its parent node after it has been newly created.
 org.alfresco.service.namespace.QName getRenditionName()
           
 org.alfresco.service.cmr.repository.NodeRef getRenditionParent()
          Returns the node to which the rendition is linked when it is first created.
 void setCallback(RenderCallback callback)
          This method sets a callback object for use in asynchronous renditions.
 void setRenditionAssociationType(org.alfresco.service.namespace.QName renditionAssociationType)
          Sets the association type used to link the rendition to its parent node after it has been newly created.
 void setRenditionParent(org.alfresco.service.cmr.repository.NodeRef renditionParent)
          Sets the node to which the rendition is linked when it is first created.
 
Methods inherited from class org.alfresco.repo.action.ActionImpl
addActionCondition, addActionCondition, addParameterValues, getActionChain, getActionCondition, getActionConditions, getActionDefinitionName, getCompensatingAction, getCreatedDate, getCreator, getDescription, getExecuteAsychronously, getExecutionEndDate, getExecutionFailureMessage, getExecutionInstance, getExecutionStartDate, getExecutionStatus, getModifiedDate, getModifier, getNodeRef, getRunAsUser, getTitle, getTrackStatus, hasActionConditions, indexOfActionCondition, removeActionCondition, removeAllActionConditions, setActionChain, setActionCondition, setCompensatingAction, setCreatedDate, setCreator, setDescription, setExecuteAsynchronously, setExecutionEndDate, setExecutionFailureMessage, setExecutionInstance, setExecutionStartDate, setExecutionStatus, setModifiedDate, setModifier, setNodeRef, setRunAsUser, setTitle, setTrackStatus, toString
 
Methods inherited from class org.alfresco.repo.action.ParameterizedItemImpl
equals, getId, getParameterValue, getParameterValues, hashCode, setParameterValue, setParameterValues
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
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
 
Methods inherited from interface org.alfresco.service.cmr.action.ParameterizedItem
getId, getParameterValue, getParameterValues, setParameterValue, setParameterValues
 

Field Detail

RENDITION_DEFINITION_NAME

public static final java.lang.String RENDITION_DEFINITION_NAME
See Also:
Constant Field Values

renditionParent

public org.alfresco.service.cmr.repository.NodeRef renditionParent

renditionAssociationType

public org.alfresco.service.namespace.QName renditionAssociationType
Constructor Detail

RenditionDefinitionImpl

public RenditionDefinitionImpl(java.lang.String id,
                               org.alfresco.service.namespace.QName renditionName,
                               java.lang.String renderingEngineName)
Parameters:
id - the action id
renditionName - a unique name for the rendering action.
renderingEngineName - the name of the rendering action definition

RenditionDefinitionImpl

public RenditionDefinitionImpl(Action action)

RenditionDefinitionImpl

public RenditionDefinitionImpl(Action action,
                               java.lang.String renderingEngineName)
Method Detail

getRenditionName

public org.alfresco.service.namespace.QName getRenditionName()
Specified by:
getRenditionName in interface RenditionDefinition
Returns:
the name which uniquely identifies this rendition definition.

getRenditionParent

public org.alfresco.service.cmr.repository.NodeRef getRenditionParent()
Description copied from interface: RenditionDefinition
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.

Specified by:
getRenditionParent in interface RenditionDefinition
Returns:
the renditionParent

setRenditionParent

public void setRenditionParent(org.alfresco.service.cmr.repository.NodeRef renditionParent)
Description copied from interface: RenditionDefinition
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.

Specified by:
setRenditionParent in interface RenditionDefinition
Parameters:
renditionParent - the renditionParent to set

getRenditionAssociationType

public org.alfresco.service.namespace.QName getRenditionAssociationType()
Description copied from interface: RenditionDefinition
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.

Specified by:
getRenditionAssociationType in interface RenditionDefinition
Returns:
the renditionAssociationType

setRenditionAssociationType

public void setRenditionAssociationType(org.alfresco.service.namespace.QName renditionAssociationType)
Description copied from interface: RenditionDefinition
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.

Specified by:
setRenditionAssociationType in interface RenditionDefinition
Parameters:
renditionAssociationType - the renditionAssociationType to set

setCallback

public void setCallback(RenderCallback callback)
Description copied from interface: RenditionDefinition
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.

Specified by:
setCallback in interface RenditionDefinition
Parameters:
callback - a callback object, which may be null.

getCallback

public RenderCallback getCallback()
Description copied from interface: RenditionDefinition
This method gets the registered callback object for use with asynchronous renditions.

Specified by:
getCallback in interface RenditionDefinition
Returns:
the callback object


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.