Package org.alfresco.repo.rendition

Interface RenditionDefinitionPersister

All Known Subinterfaces:

RenditionService

All Known Implementing Classes:

RenditionDefinitionPersisterImpl, RenditionServiceImpl

public interface RenditionDefinitionPersister

This class provides the implementation of RenditionDefinition persistence.

Note that rendition definitions are saved underneath the Data Dictionary and therefore any code which loads or saves rendition definitions must have the appropriate authorisation.

Since:

3.3

Author:

Nick Smith, Neil McErlean

Method Summary

Modifier and Type	Method	Description
RenditionDefinition	loadRenditionDefinition(org.alfresco.service.namespace.QName renditionName)	This method retrieves a RenditionDefinition that has been stored in the repository using the save() method.
java.util.List<RenditionDefinition>	loadRenditionDefinitions()	This method retrieves the RenditionDefinitions that have been stored in the repository using the save() method.
java.util.List<RenditionDefinition>	loadRenditionDefinitions(java.lang.String renderingEngineName)	This method retrieves the stored RenditionDefinitions that have been registered for the specified rendering engine name.
void	saveRenditionDefinition(RenditionDefinition renditionDefinition)	This method serializes the RenditionDefinition and stores it in the repository.

Method Detail

saveRenditionDefinition

void saveRenditionDefinition(RenditionDefinition renditionDefinition)

This method serializes the RenditionDefinition and stores it in the repository. RenditionDefinitions saved in this way may be retrieved using the load() method.

Parameters:

renditionDefinition - The RenditionDefinition to be persisted.

loadRenditionDefinition

RenditionDefinition loadRenditionDefinition(org.alfresco.service.namespace.QName renditionName)

This method retrieves a RenditionDefinition that has been stored in the repository using the save() method. If no RenditionDefinition exists in the repository with the specified rendition name then this method returns null.

Parameters:

renditionName - The unique identifier used to specify the RenditionDefinition to retrieve.

Returns:

The specified RenditionDefinition or null.

loadRenditionDefinitions

java.util.List<RenditionDefinition> loadRenditionDefinitions()

This method retrieves the RenditionDefinitions that have been stored in the repository using the save() method.

If there are no such RenditionDefinitions, an empty list is returned.

Returns:

The RenditionDefinitions.

loadRenditionDefinitions

java.util.List<RenditionDefinition> loadRenditionDefinitions(java.lang.String renderingEngineName)

This method retrieves the stored RenditionDefinitions that have been registered for the specified rendering engine name.

If there are no such rendering RenditionDefinitions, an empty list is returned.

Parameters:

renderingEngineName - the name of a rendering engine. This is usually the spring bean name.

Returns:

The RenditionDefinitions.

Throws:

java.lang.NullPointerException - if the renderingEngineName is null.

See Also:

saveRenditionDefinition(RenditionDefinition)