org.ametys.cms.repository

Class ModifiableContentHelper

java.lang.Object

org.ametys.cms.repository.ModifiableContentHelper

All Implemented Interfaces:

Component, Serviceable

public class ModifiableContentHelper
extends Object
implements Component, Serviceable

Provides helper methods to use the ModifiableContent API on DefaultContents.

Field Summary

Fields

Modifier and Type	Field and Description
private ContentTypesHelper	_contentTypesHelper
static String	METADATA_CONTRIBUTOR Constants for last contributor Metadata*
static String	METADATA_CREATION Constants for lastModified Metadata*
static String	METADATA_CREATOR Constants for author Metadata*
static String	METADATA_LANGUAGE Constants for language Metadata*
static String	METADATA_LAST_MAJORVALIDATION Constants for lastMajorValidationDate Metadata*
static String	METADATA_LAST_VALIDATION Constants for lastValidationDate Metadata*
static String	METADATA_MODIFIED Constants for lastModified Metadata*
static String	METADATA_OUTGOING_REFERENCE_NODETYPE Constants for the outgoing reference property
static String	METADATA_OUTGOING_REFERENCE_PROPERTY Constants for the outgoing reference property
static String	METADATA_OUTGOING_REFERENCES Constants for the outgoing references node
static String	METADATA_OUTGOING_REFERENCES_PATH_PROPERTY Constants for the outgoing references path property
static String	METADATA_ROOT_OUTGOING_REFERENCES Constants for the root outgoing references node
static String	METADATA_TITLE Constants for title Metadata*
static String	ROLE The Avalon role

Constructor Summary

Constructors

Constructor and Description
ModifiableContentHelper()

Method Summary

Modifier and Type	Method and Description
void	copyTitle(Content srcContent, ModifiableContent targetContent) Copy the title of the source content to the target content
void	service(ServiceManager manager)
void	setCreationDate(DefaultContent content, Date creationDate) Set a DefaultContent creation date.
void	setCreator(DefaultContent content, UserIdentity user) Set a DefaultContent user.
void	setLanguage(DefaultContent content, String language) Set a DefaultContent language.
void	setLastContributor(DefaultContent content, UserIdentity user) Set a DefaultContent contributor.
void	setLastMajorValidationDate(DefaultContent content, Date validationDate) Set a DefaultContent last major validation date.
void	setLastModified(DefaultContent content, Date lastModified) Set a DefaultContent last modification date.
void	setLastValidationDate(DefaultContent content, Date validationDate) Set a DefaultContent last validation date.
void	setMixinTypes(DefaultContent content, String[] mixins) Set DefaultContent mixins.
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.
void	setType(DefaultContent content, String type) Set a DefaultContent type.
void	setTypes(DefaultContent content, String[] types) Set DefaultContent types.

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The Avalon role

METADATA_ROOT_OUTGOING_REFERENCES

public static final String METADATA_ROOT_OUTGOING_REFERENCES

Constants for the root outgoing references node

See Also:

Constant Field Values

METADATA_OUTGOING_REFERENCES

public static final String METADATA_OUTGOING_REFERENCES

Constants for the outgoing references node

See Also:

Constant Field Values

METADATA_OUTGOING_REFERENCES_PATH_PROPERTY

public static final String METADATA_OUTGOING_REFERENCES_PATH_PROPERTY

Constants for the outgoing references path property

See Also:

Constant Field Values

METADATA_OUTGOING_REFERENCE_PROPERTY

public static final String METADATA_OUTGOING_REFERENCE_PROPERTY

Constants for the outgoing reference property

See Also:

Constant Field Values

METADATA_OUTGOING_REFERENCE_NODETYPE

public static final String METADATA_OUTGOING_REFERENCE_NODETYPE

Constants for the outgoing reference property

See Also:

Constant Field Values

METADATA_LANGUAGE

public static final String METADATA_LANGUAGE

Constants for language Metadata*

See Also:

Constant Field Values

METADATA_TITLE

public static final String METADATA_TITLE

Constants for title Metadata*

See Also:

Constant Field Values

METADATA_CREATOR

public static final String METADATA_CREATOR

Constants for author Metadata*

See Also:

Constant Field Values

METADATA_CREATION

public static final String METADATA_CREATION

Constants for lastModified Metadata*

See Also:

Constant Field Values

METADATA_LAST_VALIDATION

public static final String METADATA_LAST_VALIDATION

Constants for lastValidationDate Metadata*

See Also:

Constant Field Values

METADATA_LAST_MAJORVALIDATION

public static final String METADATA_LAST_MAJORVALIDATION

Constants for lastMajorValidationDate Metadata*

See Also:

Constant Field Values

METADATA_CONTRIBUTOR

public static final String METADATA_CONTRIBUTOR

Constants for last contributor Metadata*

See Also:

Constant Field Values

METADATA_MODIFIED

public static final String METADATA_MODIFIED

Constants for lastModified Metadata*

See Also:

Constant Field Values

_contentTypesHelper

private ContentTypesHelper _contentTypesHelper

Constructor Detail

ModifiableContentHelper

public ModifiableContentHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

setType

public void setType(DefaultContent content,
                    String type)
             throws AmetysRepositoryException

Set a DefaultContent type.

Parameters:

content - the DefaultContent to set.

type - the type.

Throws:

AmetysRepositoryException - if an error occurs.

setTypes

public void setTypes(DefaultContent content,
                     String[] types)
              throws AmetysRepositoryException

Set DefaultContent types.

Parameters:

content - the DefaultContent to set.

types - the types.

Throws:

AmetysRepositoryException - if an error occurs.

setMixinTypes

public void setMixinTypes(DefaultContent content,
                          String[] mixins)
                   throws AmetysRepositoryException

Set DefaultContent mixins.

Parameters:

content - the DefaultContent to set.

mixins - the mixins.

Throws:

AmetysRepositoryException - if an error occurs.

setLanguage

public void setLanguage(DefaultContent content,
                        String language)
                 throws AmetysRepositoryException

Set a DefaultContent language.

Parameters:

content - the DefaultContent to modify.

language - the language to set.

Throws:

AmetysRepositoryException - if an error occurs.

setTitle

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

Set a DefaultContent title for the given locale. Be careful ! Can be invoked only if the metadata title already exists.

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,
                            Date 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,
                            Date 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.

setLastValidationDate

public void setLastValidationDate(DefaultContent content,
                                  Date 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.

setLastMajorValidationDate

public void setLastMajorValidationDate(DefaultContent content,
                                       Date 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.