Package org.alfresco.service.cmr.rendition

Interface RenditionDefinition

  • All Superinterfaces:
    Action, ParameterizedItem, java.io.Serializable
    All Known Subinterfaces:
    CompositeRenditionDefinition
    All Known Implementing Classes:
    CompositeRenditionDefinitionImpl, RenditionDefinitionImpl
    @Deprecated
@AlfrescoPublicApi
public interface RenditionDefinition
extends Action, java.io.Serializable
    Deprecated.
    The RenditionService is being replace by the simpler async RenditionService2.
    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 Detail

      • getRenditionName

        org.alfresco.service.namespace.QName getRenditionName()
        Deprecated.
        Returns:
        the name which uniquely identifies this rendition definition.

      • getRenditionParent

        org.alfresco.service.cmr.repository.NodeRef getRenditionParent()
        Deprecated.
        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​(org.alfresco.service.cmr.repository.NodeRef renditionParent)
        Deprecated.
        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

        org.alfresco.service.namespace.QName getRenditionAssociationType()
        Deprecated.
        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​(org.alfresco.service.namespace.QName renditionAssociationType)
        Deprecated.
        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​(RenderCallback callback)
        Deprecated.
        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

        RenderCallback getCallback()
        Deprecated.
        This method gets the registered callback object for use with asynchronous renditions.
        Returns:
        the callback object