Package org.alfresco.rest.api

Interface Renditions

All Known Implementing Classes:

RenditionsImpl

public interface Renditions

Renditions API

Author:

Jamal Kaabi-Mofrad, janv

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PARAM_ATTACHMENT
static java.lang.String	PARAM_PLACEHOLDER
static java.lang.String	PARAM_STATUS

Method Summary

Modifier and Type	Method	Description
void	createRendition(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.lang.String versionId, Rendition rendition, boolean executeAsync, Parameters parameters)	Creates a rendition for the given node - either async r sync
void	createRendition(org.alfresco.service.cmr.repository.NodeRef nodeRef, Rendition rendition, boolean executeAsync, Parameters parameters)	Creates a rendition for the given node - either async r sync
void	createRendition(org.alfresco.service.cmr.repository.NodeRef nodeRef, Rendition rendition, Parameters parameters)	Creates a rendition for the given node asynchronously.
void	createRenditions(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.lang.String versionId, java.util.List<Rendition> renditions, Parameters parameters)	Creates renditions that don't already exist for the given node asynchronously.
void	createRenditions(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.util.List<Rendition> renditions, Parameters parameters)	Creates renditions that don't already exist for the given node asynchronously.
BinaryResource	getContent(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.lang.String versionId, java.lang.String renditionId, Parameters parameters)	Downloads rendition.
BinaryResource	getContent(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.lang.String renditionId, Parameters parameters)	Downloads rendition.
BinaryResource	getContentNoValidation(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.lang.String versionId, java.lang.String renditionId, Parameters parameters)	Downloads rendition.
BinaryResource	getContentNoValidation(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.lang.String renditionId, Parameters parameters)	Downloads rendition.
Rendition	getRendition(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.lang.String versionId, java.lang.String renditionId, Parameters parameters)	Gets information about a rendition of a node in the repository.
Rendition	getRendition(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.lang.String renditionId, Parameters parameters)	Gets information about a rendition of a node in the repository.
CollectionWithPagingInfo<Rendition>	getRenditions(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.lang.String versionId, Parameters parameters)	Lists all available renditions includes those that have been created and those that are yet to be created.
CollectionWithPagingInfo<Rendition>	getRenditions(org.alfresco.service.cmr.repository.NodeRef nodeRef, Parameters parameters)	Lists all available renditions includes those that have been created and those that are yet to be created.

Field Detail

PARAM_STATUS

static final java.lang.String PARAM_STATUS

See Also:

Constant Field Values

PARAM_ATTACHMENT

static final java.lang.String PARAM_ATTACHMENT

See Also:

Constant Field Values

PARAM_PLACEHOLDER

static final java.lang.String PARAM_PLACEHOLDER

See Also:

Constant Field Values

Method Detail

getRenditions

CollectionWithPagingInfo<Rendition> getRenditions(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                                  Parameters parameters)

Lists all available renditions includes those that have been created and those that are yet to be created.

Parameters:

nodeRef - the source/live nodeRef

parameters - the Parameters object to get the parameters passed into the request

Returns:

the rendition results

getRenditions

CollectionWithPagingInfo<Rendition> getRenditions(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                                  java.lang.String versionId,
                                                  Parameters parameters)

Lists all available renditions includes those that have been created and those that are yet to be created.

Parameters:

nodeRef - the source/live nodeRef

versionId - the version id (aka version label)

parameters - the Parameters object to get the parameters passed into the request

Returns:

the rendition results

getRendition

Rendition getRendition(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                       java.lang.String renditionId,
                       Parameters parameters)

Gets information about a rendition of a node in the repository. If there is no rendition, then returns the available/registered rendition.

Parameters:

nodeRef - the source nodeRef, ie. live node

renditionId - the rendition id

parameters - the Parameters object to get the parameters passed into the request

Returns:

the Rendition object

getRendition

Rendition getRendition(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                       java.lang.String versionId,
                       java.lang.String renditionId,
                       Parameters parameters)

Gets information about a rendition of a node in the repository. If there is no rendition, then returns the available/registered rendition.

Parameters:

nodeRef - the source nodeRef, ie. live node

versionId - the version id (aka version label)

renditionId - the rendition id

parameters - the Parameters object to get the parameters passed into the request

Returns:

the Rendition object

createRendition

void createRendition(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                     Rendition rendition,
                     Parameters parameters)

Creates a rendition for the given node asynchronously.

Parameters:

nodeRef - the source nodeRef, ie. live node

rendition - the Rendition request

parameters - the Parameters object to get the parameters passed into the request

createRendition

void createRendition(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                     Rendition rendition,
                     boolean executeAsync,
                     Parameters parameters)

Creates a rendition for the given node - either async r sync

Parameters:

nodeRef - the source nodeRef, ie. live node

rendition - the Rendition request

executeAsync -

parameters -

createRendition

void createRendition(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                     java.lang.String versionId,
                     Rendition rendition,
                     boolean executeAsync,
                     Parameters parameters)

Creates a rendition for the given node - either async r sync

Parameters:

nodeRef - the source nodeRef, ie. live node

versionId - the version id (aka version label)

rendition - the Rendition request

executeAsync -

parameters -

createRenditions

void createRenditions(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                      java.util.List<Rendition> renditions,
                      Parameters parameters)
               throws NotFoundException,
                      ConstraintViolatedException

Creates renditions that don't already exist for the given node asynchronously.

Parameters:

nodeRef - the source nodeRef, ie. live node

renditions - the list of Rendition requests

parameters - the Parameters object to get the parameters passed into the request

Throws:

NotFoundException - if any of the rendition id do not exist.

ConstraintViolatedException - if all of the renditions already exist.

createRenditions

void createRenditions(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                      java.lang.String versionId,
                      java.util.List<Rendition> renditions,
                      Parameters parameters)
               throws NotFoundException,
                      ConstraintViolatedException

Creates renditions that don't already exist for the given node asynchronously.

Parameters:

nodeRef - the source nodeRef, ie. live node

versionId - the version id (aka version label)

renditions - the list of Rendition requests

parameters - the Parameters object to get the parameters passed into the request

Throws:

NotFoundException - if any of the rendition id do not exist.

ConstraintViolatedException - if all of the renditions already exist.

getContent

BinaryResource getContent(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                          java.lang.String renditionId,
                          Parameters parameters)

Downloads rendition.

Parameters:

nodeRef - the source nodeRef, ie. live node

renditionId - the rendition id

parameters - the Parameters object to get the parameters passed into the request

Returns:

the rendition stream

getContent

BinaryResource getContent(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                          java.lang.String versionId,
                          java.lang.String renditionId,
                          Parameters parameters)

Downloads rendition.

Parameters:

nodeRef - the source nodeRef, ie. live node

versionId - the version id (aka version label)

renditionId - the rendition id

parameters - the Parameters object to get the parameters passed into the request

Returns:

the rendition stream

getContentNoValidation

BinaryResource getContentNoValidation(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                      java.lang.String renditionId,
                                      Parameters parameters)

Downloads rendition.

Parameters:

nodeRef - the source nodeRef, ie. live node

renditionId - the rendition id

parameters - the Parameters object to get the parameters passed into the request

Returns:

the rendition stream

getContentNoValidation

BinaryResource getContentNoValidation(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                      java.lang.String versionId,
                                      java.lang.String renditionId,
                                      Parameters parameters)

Downloads rendition.

Parameters:

nodeRef - the source nodeRef, ie. live node

versionId - the version id (aka version label)

renditionId - the rendition id

parameters - the Parameters object to get the parameters passed into the request

Returns:

the rendition stream