Package org.ametys.cms.repository

Class ModifiableContentHelper

java.lang.Object

org.ametys.cms.repository.ModifiableContentHelper

All Implemented Interfaces:

Component

public class ModifiableContentHelper
extends Object
implements Component

Provides helper methods to use the ModifiableContent API on DefaultContents.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METADATA_COMMENTS	Constants for the root of comments
static final String	METADATA_CONTRIBUTOR_COMMENTS	Constants for the root of contributor comments
static final String	ROLE	The Avalon role

Constructor Summary

Constructors

Constructor	Description
ModifiableContentHelper()

Method Summary

Modifier and Type	Method	Description
protected void	_storeDatetimeMetadata(DefaultContent content, String metadataName, ZonedDateTime date)	Store a metadata of type datetime in the content
protected void	_storeUserMetadata(DefaultContent content, String metadataName, UserIdentity user)	Store a metadata of type user in the content
void	copyTitle(Content srcContent, ModifiableContent targetContent)	Copy the title of the source content to the target content
ModifiableModelLessDataHolder	getCommentsDataHolder(DefaultContent content, boolean createNew)	Retrieves the data holder for the given content's comments
ModifiableModelLessDataHolder	getContributorCommentsDataHolder(DefaultContent content, boolean createNew)	Retrieves the data holder for the given content's contributor comments
void	setCreationDate(DefaultContent content, ZonedDateTime creationDate)	Set a DefaultContent creation date.
void	setCreator(DefaultContent content, UserIdentity user)	Set a DefaultContent user.
void	setFirstValidationDate(DefaultContent content, ZonedDateTime validationDate)	Set a DefaultContent first validation date.
void	setFirstValidator(DefaultContent content, UserIdentity user)	Set a DefaultContent first validator.
void	setLastContributor(DefaultContent content, UserIdentity user)	Set a DefaultContent contributor.
void	setLastMajorValidationDate(DefaultContent content, ZonedDateTime validationDate)	Set a DefaultContent last major validation date.
void	setLastMajorValidator(DefaultContent content, UserIdentity user)	Set a DefaultContent last major validator.
void	setLastModified(DefaultContent content, ZonedDateTime lastModified)	Set a DefaultContent last modification date.
void	setLastValidationDate(DefaultContent content, ZonedDateTime validationDate)	Set a DefaultContent last validation date.
void	setLastValidator(DefaultContent content, UserIdentity user)	Set a DefaultContent last validator.
void	setOutgoingReferences(DefaultContent content, Map<String,OutgoingReferences> references)	Store the outgoing references on the content.
void	setTitle(DefaultContent content, String title)	Set the title of non-multilingual DefaultContent.
void	setTitle(DefaultContent content, String title, Locale locale)	Set a DefaultContent title for the given locale.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ROLE

public static final String ROLE

The Avalon role

METADATA_COMMENTS

public static final String METADATA_COMMENTS

Constants for the root of comments

See Also:

• Constant Field Values

METADATA_CONTRIBUTOR_COMMENTS

public static final String METADATA_CONTRIBUTOR_COMMENTS

Constants for the root of contributor comments

See Also:

• Constant Field Values

Constructor Details

ModifiableContentHelper

public ModifiableContentHelper()

Method Details

setTitle

public void setTitle(DefaultContent content,
 String title,
 Locale locale)
              throws AmetysRepositoryException

Set a DefaultContent title for the given locale.

Parameters:

content - the DefaultContent to set.

title - the title to set.

locale - The locale. Can be null if the content is not a multilingual content.

Throws:

AmetysRepositoryException - if an error occurs.

setTitle

public void setTitle(DefaultContent content,
 String title)
              throws AmetysRepositoryException

Set the title of non-multilingual DefaultContent. Be careful! Use only if content's title is not a multilingual string. If not sure use setTitle(DefaultContent, String, Locale) instead.

Parameters:

content - the DefaultContent to set.

title - the title to set.

Throws:

AmetysRepositoryException - if an error occurs.

copyTitle

public void copyTitle(Content srcContent,
 ModifiableContent targetContent)
               throws AmetysRepositoryException

Copy the title of the source content to the target content

Parameters:

srcContent - The source content

targetContent - The target content

Throws:

AmetysRepositoryException - if an error occurs.

setCreator

public void setCreator(DefaultContent content,
 UserIdentity user)
                throws AmetysRepositoryException

Set a DefaultContent user.

Parameters:

content - the DefaultContent to set.

user - the user to set.

Throws:

AmetysRepositoryException - if an error occurs.

setCreationDate

public void setCreationDate(DefaultContent content,
 ZonedDateTime creationDate)
                     throws AmetysRepositoryException

Set a DefaultContent creation date.

Parameters:

content - the DefaultContent to set.

creationDate - the creation date to set.

Throws:

AmetysRepositoryException - if an error occurs.

setLastContributor

public void setLastContributor(DefaultContent content,
 UserIdentity user)
                        throws AmetysRepositoryException

Set a DefaultContent contributor.

Parameters:

content - the DefaultContent to set.

user - the contributor to set.

Throws:

AmetysRepositoryException - if an error occurs.

setLastModified

public void setLastModified(DefaultContent content,
 ZonedDateTime lastModified)
                     throws AmetysRepositoryException

Set a DefaultContent last modification date.

Parameters:

content - the DefaultContent to set.

lastModified - the last modification date to set.

Throws:

AmetysRepositoryException - if an error occurs.

setFirstValidator

public void setFirstValidator(DefaultContent content,
 UserIdentity user)
                       throws AmetysRepositoryException

Set a DefaultContent first validator.

Parameters:

content - the DefaultContent to set.

user - the validator to set.

Throws:

AmetysRepositoryException - if an error occurs.

setFirstValidationDate

public void setFirstValidationDate(DefaultContent content,
 ZonedDateTime validationDate)
                            throws AmetysRepositoryException

Set a DefaultContent first validation date.

Parameters:

content - the DefaultContent to set.

validationDate - the first validation date.

Throws:

AmetysRepositoryException - if an error occurs.

setLastValidator

public void setLastValidator(DefaultContent content,
 UserIdentity user)
                      throws AmetysRepositoryException

Set a DefaultContent last validator.

Parameters:

content - the DefaultContent to set.

user - the validator to set.

Throws:

AmetysRepositoryException - if an error occurs.

setLastValidationDate

public void setLastValidationDate(DefaultContent content,
 ZonedDateTime validationDate)
                           throws AmetysRepositoryException

Set a DefaultContent last validation date.

Parameters:

content - the DefaultContent to set.

validationDate - the last validation date.

Throws:

AmetysRepositoryException - if an error occurs.

setLastMajorValidator

public void setLastMajorValidator(DefaultContent content,
 UserIdentity user)
                           throws AmetysRepositoryException

Set a DefaultContent last major validator.

Parameters:

content - the DefaultContent to set.

user - the validator to set.

Throws:

AmetysRepositoryException - if an error occurs.

setLastMajorValidationDate

public void setLastMajorValidationDate(DefaultContent content,
 ZonedDateTime validationDate)
                                throws AmetysRepositoryException

Set a DefaultContent last major validation date.

Parameters:

content - the DefaultContent to set.

validationDate - the last major validation date.

Throws:

AmetysRepositoryException - if an error occurs.

setOutgoingReferences

public void setOutgoingReferences(DefaultContent content,
 Map<String,OutgoingReferences> references)
                           throws AmetysRepositoryException

Store the outgoing references on the content.

Parameters:

content - The content concerned by these outgoing references.

references - A non null map of outgoing references grouped by metadata (key are metadata path)

Throws:

AmetysRepositoryException - if an error occurs.

_storeDatetimeMetadata

protected void _storeDatetimeMetadata(DefaultContent content,
 String metadataName,
 ZonedDateTime date)

Store a metadata of type datetime in the content

Parameters:

content - the content described by the metadata

metadataName - the name of the metadata

date - the value to set

Throws:

AmetysRepositoryException - when an error occurred

_storeUserMetadata

protected void _storeUserMetadata(DefaultContent content,
 String metadataName,
 UserIdentity user)
                           throws AmetysRepositoryException

Store a metadata of type user in the content

Parameters:

content - the content described by the metadata

metadataName - the name of the metadata

user - the value to set

Throws:

AmetysRepositoryException - when an error occurred

getCommentsDataHolder

public ModifiableModelLessDataHolder getCommentsDataHolder(DefaultContent content,
 boolean createNew)

Retrieves the data holder for the given content's comments

Parameters:

content - the content

createNew - true to create the comments' data holder if it does not already exist, false otherwise

Returns:

the data holder for content's comments, or null if the data holder does not already exist and createNew is set to false

getContributorCommentsDataHolder

public ModifiableModelLessDataHolder getContributorCommentsDataHolder(DefaultContent content,
 boolean createNew)

Retrieves the data holder for the given content's contributor comments

Parameters:

content - the content

createNew - true to create the contributor comments' data holder if it does not already exist, false otherwise

Returns:

the data holder for content's contributor comments, or null if the data holder does not already exist and createNew is set to false