com.adobe.cq.dam.cfm

Interface ContentVariation

All Superinterfaces:

Versionable

public interface ContentVariation
extends Versionable

Implementations of this interface allow to access a variation of a content element through a stable API, agnostic to the underlying content structure.

Variations can be synchronized with some other element. If the implementation does not provide enhances synchronization capabilities (which it is free to do), it should synchronize with the element content.

The synchronization works by using the synchronization source, taking their content, optionally applying some rules and then updating the variation with that content.

How the synchronization source is defined and how the source content is processed is implementation specific. This API only provides means to manage the synchronization state and triggering the synchronization.

The synchronization state is represented by the SyncStatus enumeration.

Transactional behavior: The caller is responsible for committing the respective ResourceResolver after calling one or more methods that change a content fragment unless specified otherwise.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContent() Gets the content of the variation.
java.lang.String	getContentType() Gets the MIME type of the variation.
java.lang.String	getDescription() Gets a description for the variation.
java.lang.String	getName() Gets the (technical) name of the variation.
SyncStatus	getSyncStatus() Gets the synchronization status of the variation.
java.lang.String	getTitle() Gets the (human-readable) title of the variation.
void	setContent(java.lang.String content, java.lang.String contentType) Sets the content of the variation.
void	synchronize() Synchronizes the variation.

Methods inherited from interface com.adobe.cq.dam.cfm.Versionable

createVersion, getVersionedContent, listVersions

Method Detail

getName

java.lang.String getName()

Gets the (technical) name of the variation.

Returns:

The name of the variation

getTitle

java.lang.String getTitle()

Gets the (human-readable) title of the variation.

Returns:

The title of the variation

getDescription

java.lang.String getDescription()

Gets a description for the variation.

Returns:

The description

getContentType

java.lang.String getContentType()

Gets the MIME type of the variation.

Returns:

The MIME type; refers to some text format

getContent

java.lang.String getContent()

Gets the content of the variation.

Returns:

The content of the variation

setContent

void setContent(java.lang.String content,
                java.lang.String contentType)
         throws ContentFragmentException

Sets the content of the variation.

The specified content & its MIME type must be textual. What MIME types are eventually supported is left to the implementation.

Parameters:

content - The content

contentType - The MIME type of the content

Throws:

ContentFragmentException - if the content could not be written

java.lang.IllegalArgumentException - if the specified MIME type is not supported or not a textual MIME type

getSyncStatus

SyncStatus getSyncStatus()

Gets the synchronization status of the variation.

Returns:

The synchronization state of the provided variation

synchronize

void synchronize()
          throws ContentFragmentException

Synchronizes the variation.

Throws:

ContentFragmentException - if the synchronization failed