org.ametys.cms.repository

Class DefaultContent<F extends ContentFactory>

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

org.ametys.plugins.repository.jcr.SimpleAmetysObject<F>

org.ametys.plugins.repository.jcr.DefaultAmetysObject<F>

org.ametys.cms.repository.DefaultContent<F>

Type Parameters:

F - the actual type of factory.

All Implemented Interfaces:

Content, ReactionableObject, TagAwareAmetysObject, ACLAmetysObject, AmetysObject, CopiableAmetysObject, DataAwareAmetysObject, ModelAwareDataAwareAmetysObject, DataHolder, ModelAwareDataHolder, DublinCoreAwareAmetysObject, JCRAmetysObject, JCRTraversableAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, ModifiableTraversableAmetysObject, RemovableAmetysObject, TraversableAmetysObject, MetadataAndVersionAwareAmetysObject, ModifiableMetadataAwareVersionableAmetysObject, VersionableAmetysObject, VersionAwareAmetysObject

Direct Known Subclasses:

DefaultWebContent, DefaultWorkflowAwareContent, ModifiableDefaultContent

public class DefaultContent<F extends ContentFactory>
extends DefaultAmetysObject<F>
implements Content, CopiableAmetysObject, JCRTraversableAmetysObject, ReactionableObject

Default implementation of a Content, also versionable, lockable and workflow-aware.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.cms.repository.ReactionableObject

ReactionableObject.ReactionType

Field Summary

Fields

Modifier and Type	Field and Description
private static Logger	__logger
private boolean	_lockAlreadyChecked
private List<Model>	_models
static String	ATTACHMENTS_NODE_NAME Constant for the attachment node name.
static Locale	DEFAULT_CONTENT_LOCALE The default locale for content
static String	METADATA_CONTENTTYPE Constants for contentType Metadata*
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_FIRST_VALIDATION Constants for firstValidationDate 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_MIXINCONTENTTYPES Constants for contentType Metadata*
static String	METADATA_MODIFIED Constants for lastModified Metadata*
static String	METADATA_OUTGOING_REFERENCE_NODETYPE Constants for the outgoing reference nodetype
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

Fields inherited from class org.ametys.plugins.repository.jcr.DefaultAmetysObject

PROTECTED_PROPERTIES

Fields inherited from interface org.ametys.cms.repository.Content

ATTRIBUTE_TITLE, METADATA_TITLE

Constructor Summary

Constructors

Constructor and Description
DefaultContent(Node node, String parentPath, F factory) Creates a JCR-based Content.

Method Summary

Modifier and Type	Method and Description
(package private) void	_checkLock()
void	addReaction(UserIdentity user, ReactionableObject.ReactionType reactionType) Add the user reaction
ModifiableContent	copyTo(ModifiableTraversableAmetysObject parent, String name) Copy the current AmetysObject to the given object.
ModifiableContent	copyTo(ModifiableTraversableAmetysObject parent, String name, int initWorkflowActionId) Copy the current DefaultWorkflowAwareContent to the given object.
ModifiableContent	copyTo(ModifiableTraversableAmetysObject parent, String name, List<String> restrictTo) Copy the current AmetysObject to the given object if it is not in the restriction list.
ModifiableContent	copyTo(ModifiableTraversableAmetysObject parent, String name, String lang, int initWorkflowActionId) Copy the current DefaultWorkflowAwareContent to the given object.
ModifiableContent	copyTo(ModifiableTraversableAmetysObject parent, String name, String lang, int initWorkflowActionId, boolean waitAsyncObservers, boolean copyACL) Copy the current DefaultWorkflowAwareContent to the given object.
<A extends AmetysObject> A	createChild(String name, String type) Creates a child below current object.
<A extends AmetysObject> A	getChild(String path) Retrieves a given child from its relative path.
<A extends AmetysObject> AmetysObjectIterable<A>	getChildren() Retrieves children of the current object.
Date	getCreationDate() Retrieves the creation date.
UserIdentity	getCreator() Retrieves the login of the creator.
ModelAwareDataHolder	getDataHolder() Returns the DataHolder of this AmetysObject.
String	getDCContributor() Get the Dublin Core contributor.
String	getDCCoverage() Get the Dublin Core coverage.
String	getDCCreator() Get the Dublin Core creator.
Date	getDCDate() Get the Dublin Core date.
String	getDCDescription() Get the Dublin Core description.
String	getDCFormat() Get the Dublin Core format.
String	getDCIdentifier() Get the Dublin Core identifier.
String	getDCLanguage() Get the Dublin Core language.
String	getDCPublisher() Get the Dublin Core publisher.
String	getDCRelation() Get the Dublin Core relation.
String	getDCRights() Get the Dublin Core rights.
String	getDCSource() Get the Dublin Core source.
String[]	getDCSubject() Get the Dublin Core subject.
String	getDCTitle() Get the Dublin Core title.
String	getDCType() Get the Dublin Core type.
ModelItem	getDefinition(String dataPath) Retrieves the definition of the data at the given path
Date	getFirstValidationDate() Retrieves the first validation date
String	getLanguage() Retrieves the language of this content.
UserIdentity	getLastContributor() Retrieves the login of the last contributor.
Date	getLastMajorValidationDate() Retrieves the last validation date resulting from a major modification.
Date	getLastModified() Retrieves the last modification date.
Date	getLastValidationDate() Retrieves the last validation date
String[]	getMixinTypes() Retrieves the mixin types of this content.
protected List<Model>	getModels() Retrieves the model of the content as an array
Map<String,OutgoingReferences>	getOutgoingReferences() Get the stored outgoing references of the content.
List<UserIdentity>	getReactionUsers(ReactionableObject.ReactionType reactionType) Get the list of users who react
Collection<Content>	getReferencingContents() Returns all Contents referencing this Content (as a metadata).
ResourceCollection	getRootAttachments() Retrieves the attachments root node
Set<String>	getTags() Retrieves current tags.
String	getTitle() Retrieves the title.
String	getTitle(Locale locale) Retrieves the title for the given locale.
String[]	getTypes() Retrieves the types of this content.
boolean	hasChild(String name) Tests if this Object has at least one child with the given name.
boolean	hasReferencingContents() Returns true if there is at least one Content referencing this Content (as a metadata).
void	removeReaction(UserIdentity user, ReactionableObject.ReactionType reactionType) Remove the user reaction

Methods inherited from class org.ametys.plugins.repository.jcr.DefaultAmetysObject

addAllowedGroups, addAllowedProfilesForAnonymous, addAllowedProfilesForAnyConnectedUser, addAllowedUsers, addDeniedGroups, addDeniedProfilesForAnonymous, addDeniedProfilesForAnyConnectedUser, addDeniedUsers, addLabel, checkpoint, copyNode, getAllLabels, getAllowedGroups, getAllowedProfilesForAnonymous, getAllowedProfilesForAnyConnectedUser, getAllowedProfilesForGroups, getAllowedProfilesForUser, getAllowedProfilesForUsers, getAllowedUsers, getAllRevisions, getBaseNode, getBaseVersion, getDeniedGroups, getDeniedProfilesForAnonymous, getDeniedProfilesForAnyConnectedUser, getDeniedProfilesForGroups, getDeniedProfilesForUser, getDeniedProfilesForUsers, getDeniedUsers, getLabels, getLabels, getNode, getRevision, getRevisionTimestamp, getRevisionTimestamp, getUnversionedMetadataHolder, getVersionHistory, removeAllowedGroups, removeAllowedGroups, removeAllowedProfilesForAnonymous, removeAllowedProfilesForAnyConnectedUser, removeAllowedUsers, removeAllowedUsers, removeDeniedGroups, removeDeniedGroups, removeDeniedProfilesForAnonymous, removeDeniedProfilesForAnyConnectedUser, removeDeniedUsers, removeDeniedUsers, removeLabel, restoreFromLabel, restoreFromNode, restoreFromRevision, switchToLabel, switchToRevision

Methods inherited from class org.ametys.plugins.repository.jcr.SimpleAmetysObject

_getFactory, _invalidateName, _invalidateParentPath, getId, getMetadataHolder, getName, getParent, getParentPath, getPath, needsSave, remove, rename, revertChanges, saveChanges

Methods inherited from class org.ametys.plugins.repository.AbstractAmetysObject

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModelAwareDataAwareAmetysObject

getComposite, getRepeater, getType, getValue, getValue, hasValue, isMultiple

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.DataAwareAmetysObject

copyTo, getDataNames

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder

toSAX, toSAX

Methods inherited from interface org.ametys.plugins.repository.data.holder.DataHolder

dataToSAX, dataToSAX, dataToSAX, dataToSAX

Methods inherited from interface org.ametys.plugins.repository.ModifiableACLAmetysObject

addAllowedGroups, addAllowedProfilesForAnonymous, addAllowedProfilesForAnyConnectedUser, addAllowedUsers, addDeniedGroups, addDeniedProfilesForAnonymous, addDeniedProfilesForAnyConnectedUser, addDeniedUsers, removeAllowedGroups, removeAllowedGroups, removeAllowedProfilesForAnonymous, removeAllowedProfilesForAnyConnectedUser, removeAllowedUsers, removeAllowedUsers, removeDeniedGroups, removeDeniedGroups, removeDeniedProfilesForAnonymous, removeDeniedProfilesForAnyConnectedUser, removeDeniedUsers, removeDeniedUsers

Methods inherited from interface org.ametys.plugins.repository.ACLAmetysObject

getAllowedGroups, getAllowedProfilesForAnonymous, getAllowedProfilesForAnyConnectedUser, getAllowedProfilesForGroups, getAllowedProfilesForUser, getAllowedProfilesForUsers, getAllowedUsers, getDeniedGroups, getDeniedProfilesForAnonymous, getDeniedProfilesForAnyConnectedUser, getDeniedProfilesForGroups, getDeniedProfilesForUser, getDeniedProfilesForUsers, getDeniedUsers

Methods inherited from interface org.ametys.plugins.repository.jcr.JCRAmetysObject

getNode

Methods inherited from interface org.ametys.plugins.repository.ModifiableAmetysObject

needsSave, rename, revertChanges, saveChanges

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, getId, getName, getParent, getParentPath, getPath, hashCode

Methods inherited from interface org.ametys.plugins.repository.RemovableAmetysObject

remove

Methods inherited from interface org.ametys.plugins.repository.TraversableAmetysObject

getChildAt, getChildPosition

Field Detail

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 nodetype

See Also:

Constant Field Values

METADATA_LANGUAGE

public static final String METADATA_LANGUAGE

Constants for language 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_FIRST_VALIDATION

public static final String METADATA_FIRST_VALIDATION

Constants for firstValidationDate 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

METADATA_CONTENTTYPE

public static final String METADATA_CONTENTTYPE

Constants for contentType Metadata*

See Also:

Constant Field Values

METADATA_MIXINCONTENTTYPES

public static final String METADATA_MIXINCONTENTTYPES

Constants for contentType Metadata*

See Also:

Constant Field Values

ATTACHMENTS_NODE_NAME

public static final String ATTACHMENTS_NODE_NAME

Constant for the attachment node name.

See Also:

Constant Field Values

DEFAULT_CONTENT_LOCALE

public static final Locale DEFAULT_CONTENT_LOCALE

The default locale for content

__logger

private static Logger __logger

_lockAlreadyChecked

private boolean _lockAlreadyChecked

_models

private List<Model> _models

Constructor Detail

DefaultContent

public DefaultContent(Node node,
                      String parentPath,
                      F factory)

Creates a JCR-based Content.

Parameters:

node - the JCR Node backing this Content.

parentPath - the parent path in the Ametys hierarchy.

factory - the corresponding ContentFactory.

Method Detail

getTypes

public String[] getTypes()
                  throws AmetysRepositoryException

Description copied from interface: Content

Retrieves the types of this content.

Specified by:

getTypes in interface Content

Returns:

the types of this content.

Throws:

AmetysRepositoryException - if an error occurs.

getMixinTypes

public String[] getMixinTypes()
                       throws AmetysRepositoryException

Description copied from interface: Content

Retrieves the mixin types of this content.

Specified by:

getMixinTypes in interface Content

Returns:

the mixin types of this content.

Throws:

AmetysRepositoryException - if an error occurs.

getLanguage

public String getLanguage()
                   throws AmetysRepositoryException

Description copied from interface: Content

Retrieves the language of this content.

Specified by:

getLanguage in interface Content

Returns:

the language of this content or null if the content is a multilingual content

Throws:

AmetysRepositoryException - if an error occurs.

getTitle

public String getTitle(Locale locale)
                throws UnknownDataException,
                       AmetysRepositoryException

Description copied from interface: Content

Retrieves the title for the given locale. If the locale is null or does not exist, the first locale will be used.

Specified by:

getTitle in interface Content

Parameters:

locale - The locale. Can be null if the content is not a multilingual content or to get the title in the default locale.

Returns:

the title.

Throws:

UnknownDataException - if this property does not exist.

AmetysRepositoryException - if an error occurs.

getTitle

public String getTitle()
                throws UnknownDataException,
                       AmetysRepositoryException

Description copied from interface: Content

Retrieves the title. This method is same as Content.getTitle(Locale) with a null locale. Use this method only if you are manipulating no-multilingual content. If not sure, use Content.getTitle(Locale) instead.

Specified by:

getTitle in interface Content

Returns:

the title.

Throws:

UnknownDataException - if this property does not exist.

AmetysRepositoryException - if an error occurs.

getCreator

public UserIdentity getCreator()
                        throws UnknownDataException,
                               AmetysRepositoryException

Description copied from interface: Content

Retrieves the login of the creator.

Specified by:

getCreator in interface Content

Returns:

the login of the creator.

Throws:

UnknownDataException - if this property does not exist.

AmetysRepositoryException - if an error occurs.

getCreationDate

public Date getCreationDate()
                     throws UnknownDataException,
                            AmetysRepositoryException

Description copied from interface: Content

Retrieves the creation date.

Specified by:

getCreationDate in interface Content

Returns:

the creation date.

Throws:

UnknownDataException - if this property does not exist.

AmetysRepositoryException - if an error occurs.

getLastContributor

public UserIdentity getLastContributor()
                                throws UnknownDataException,
                                       AmetysRepositoryException

Description copied from interface: Content

Retrieves the login of the last contributor.

Specified by:

getLastContributor in interface Content

Returns:

the login of the last contributor.

Throws:

UnknownDataException - if this property does not exist.

AmetysRepositoryException - if an error occurs.

getLastModified

public Date getLastModified()
                     throws UnknownDataException,
                            AmetysRepositoryException

Description copied from interface: Content

Retrieves the last modification date.

Specified by:

getLastModified in interface Content

Returns:

the last modification date.

Throws:

UnknownDataException - if this property does not exist.

AmetysRepositoryException - if an error occurs.

getFirstValidationDate

public Date getFirstValidationDate()
                            throws UnknownDataException,
                                   AmetysRepositoryException

Description copied from interface: Content

Retrieves the first validation date

Specified by:

getFirstValidationDate in interface Content

Returns:

the first validation date

Throws:

UnknownDataException - if this property does not exist.

AmetysRepositoryException - if an error occurs.

getLastValidationDate

public Date getLastValidationDate()
                           throws UnknownDataException,
                                  AmetysRepositoryException

Description copied from interface: Content

Retrieves the last validation date

Specified by:

getLastValidationDate in interface Content

Returns:

the last validation date

Throws:

UnknownDataException - if this property does not exist.

AmetysRepositoryException - if an error occurs.

getLastMajorValidationDate

public Date getLastMajorValidationDate()
                                throws AmetysRepositoryException

Description copied from interface: Content

Retrieves the last validation date resulting from a major modification. At least this is the first validation date

Specified by:

getLastMajorValidationDate in interface Content

Returns:

the last validation date resulting from a major modification

Throws:

UnknownDataException - if this property does not exist.

AmetysRepositoryException - if an error occurs.

getTags

public Set<String> getTags()
                    throws AmetysRepositoryException

Description copied from interface: TagAwareAmetysObject

Retrieves current tags.

Specified by:

getTags in interface TagAwareAmetysObject

Returns:

the current tags.

Throws:

AmetysRepositoryException - if an error occurs.

getOutgoingReferences

public Map<String,OutgoingReferences> getOutgoingReferences()
                                                     throws AmetysRepositoryException

Description copied from interface: Content

Get the stored outgoing references of the content. This references can be used for different purposes, such as testing link consistency for example.

Specified by:

getOutgoingReferences in interface Content

Returns:

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

Throws:

AmetysRepositoryException - if an error occurs.

getReferencingContents

public Collection<Content> getReferencingContents()
                                           throws AmetysRepositoryException

Description copied from interface: Content

Returns all Contents referencing this Content (as a metadata).

Specified by:

getReferencingContents in interface Content

Returns:

all Contents referencing this Content.

Throws:

AmetysRepositoryException - if an error occurs.

hasReferencingContents

public boolean hasReferencingContents()
                               throws AmetysRepositoryException

Description copied from interface: Content

Returns true if there is at least one Content referencing this Content (as a metadata).

Specified by:

hasReferencingContents in interface Content

Returns:

true if there is at least one Content referencing this Content.

Throws:

AmetysRepositoryException - if an error occurs.

copyTo

public ModifiableContent copyTo(ModifiableTraversableAmetysObject parent,
                                String name,
                                List<String> restrictTo)
                         throws AmetysRepositoryException

Description copied from interface: CopiableAmetysObject

Copy the current AmetysObject to the given object if it is not in the restriction list. Be careful, this method save changes.

Specified by:

copyTo in interface CopiableAmetysObject

Parameters:

parent - The parent of the new object. Can not be null.

name - Name of the new object. Can be null. If null, the new name will be get from the copied object

restrictTo - A restrict list of CopiableAmetysObject authorized to be copied

Returns:

the created object

Throws:

AmetysRepositoryException - if an error occurs.

copyTo

public ModifiableContent copyTo(ModifiableTraversableAmetysObject parent,
                                String name)
                         throws AmetysRepositoryException

Description copied from interface: CopiableAmetysObject

Copy the current AmetysObject to the given object. Be careful, this method save changes.

Specified by:

copyTo in interface CopiableAmetysObject

Parameters:

parent - The parent of the new object. Can not be null.

name - Name of the new object. Can be null. If null, the new name will be get from the copied object

Returns:

the created object

Throws:

AmetysRepositoryException - if an error occurs.

copyTo

public ModifiableContent copyTo(ModifiableTraversableAmetysObject parent,
                                String name,
                                int initWorkflowActionId)
                         throws AmetysRepositoryException

Copy the current DefaultWorkflowAwareContent to the given object. Be careful, this method save changes, but do not create a new version (checkpoint)

Parameters:

parent - The parent of the new object. Can not be null.

name - Name of the new object. Can be null. If null, the new name will be get from the copied object.

initWorkflowActionId - The initial workflow action id

Returns:

the created object

Throws:

AmetysRepositoryException - if an error occurs.

copyTo

public ModifiableContent copyTo(ModifiableTraversableAmetysObject parent,
                                String name,
                                String lang,
                                int initWorkflowActionId)
                         throws AmetysRepositoryException

Copy the current DefaultWorkflowAwareContent to the given object. Be careful, this method save changes, but do not create a new version (checkpoint)

Parameters:

parent - The parent of the new object. Can not be null.

name - Name of the new object. Can be null. If null, the new name will be get from the copied object.

lang - Language of the new object. Can be null. If null, the new language will be get from the copied object.

initWorkflowActionId - The initial workflow action id

Returns:

the created object

Throws:

AmetysRepositoryException - if an error occurs.

copyTo

public ModifiableContent copyTo(ModifiableTraversableAmetysObject parent,
                                String name,
                                String lang,
                                int initWorkflowActionId,
                                boolean waitAsyncObservers,
                                boolean copyACL)
                         throws AmetysRepositoryException

Copy the current DefaultWorkflowAwareContent to the given object. Be careful, this method save changes, but do not create a new version (checkpoint)

Parameters:

parent - The parent of the new object. Can not be null.

name - Name of the new object. Can be null. If null, the new name will be get from the copied object.

lang - Language of the new object. Can be null. If null, the new language will be get from the copied object.

initWorkflowActionId - The initial workflow action id

waitAsyncObservers - if true, waits if necessary for the asynchronous observers to complete

copyACL - true to copy ACL of source content

Returns:

the created object

Throws:

AmetysRepositoryException - if an error occurs.

_checkLock

void _checkLock()
         throws RepositoryException

Throws:

RepositoryException

getDCTitle

public String getDCTitle()
                  throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core title.

Specified by:

getDCTitle in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core title. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCCreator

public String getDCCreator()
                    throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core creator.

Specified by:

getDCCreator in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core creator. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCSubject

public String[] getDCSubject()
                      throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core subject.

Specified by:

getDCSubject in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core subject. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCDescription

public String getDCDescription()
                        throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core description.

Specified by:

getDCDescription in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core description. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCPublisher

public String getDCPublisher()
                      throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core publisher.

Specified by:

getDCPublisher in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core publisher. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCContributor

public String getDCContributor()
                        throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core contributor.

Specified by:

getDCContributor in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core contributor. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCDate

public Date getDCDate()
               throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core date.

Specified by:

getDCDate in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core date. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCType

public String getDCType()
                 throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core type.

Specified by:

getDCType in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core type. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCFormat

public String getDCFormat()
                   throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core format.

Specified by:

getDCFormat in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core format. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCIdentifier

public String getDCIdentifier()
                       throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core identifier.

Specified by:

getDCIdentifier in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core identifier. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCSource

public String getDCSource()
                   throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core source.

Specified by:

getDCSource in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core source. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCLanguage

public String getDCLanguage()
                     throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core language.

Specified by:

getDCLanguage in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core language. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCRelation

public String getDCRelation()
                     throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core relation.

Specified by:

getDCRelation in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core relation. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCCoverage

public String getDCCoverage()
                     throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core coverage.

Specified by:

getDCCoverage in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core coverage. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCRights

public String getDCRights()
                   throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core rights.

Specified by:

getDCRights in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core rights. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getRootAttachments

public ResourceCollection getRootAttachments()
                                      throws AmetysRepositoryException

Description copied from interface: Content

Retrieves the attachments root node

Specified by:

getRootAttachments in interface Content

Returns:

The attachments root node, or null if the content is working on an (unmodifiable) old version and the attachments root is missing.

Throws:

AmetysRepositoryException - if an error occurs.

hasChild

public boolean hasChild(String name)
                 throws AmetysRepositoryException

Description copied from interface: TraversableAmetysObject

Tests if this Object has at least one child with the given name.

Specified by:

hasChild in interface TraversableAmetysObject

Parameters:

name - the name to test. Cannot be null nor empty nor begin with a '/' and it cannot contain '/'.

Returns:

true if the named child exists, false otherwise.

Throws:

AmetysRepositoryException - if an error occurs.

createChild

public <A extends AmetysObject> A createChild(String name,
                                              String type)
                                       throws AmetysRepositoryException,
                                              RepositoryIntegrityViolationException

Description copied from interface: ModifiableTraversableAmetysObject

Creates a child below current object.

Specified by:

createChild in interface ModifiableTraversableAmetysObject

Type Parameters:

A - the actual type of AmetysObject.

Parameters:

name - the name of the child, position ([n]) are not supported for same name sibling, the child will be added at the end of the children list.

type - the type of the object.

Returns:

the new object created.

Throws:

AmetysRepositoryException - if an error occurs.

RepositoryIntegrityViolationException - if an object with the same name already exists and same name siblings is not allowed.

getChild

public <A extends AmetysObject> A getChild(String path)
                                    throws AmetysRepositoryException,
                                           UnknownAmetysObjectException

Description copied from interface: TraversableAmetysObject

Retrieves a given child from its relative path. The path cannot be null, empty nor begin with a '/'.

Specified by:

getChild in interface TraversableAmetysObject

Type Parameters:

A - the actual type of AmetysObject.

Parameters:

path - the path of the child which can contains a position with. [n] if same name sibling is allowed.

Returns:

the child found.

Throws:

AmetysRepositoryException - if an error occurs.

UnknownAmetysObjectException - if the object does not exist.

getChildren

public <A extends AmetysObject> AmetysObjectIterable<A> getChildren()
                                                             throws AmetysRepositoryException

Description copied from interface: TraversableAmetysObject

Retrieves children of the current object.

Specified by:

getChildren in interface TraversableAmetysObject

Type Parameters:

A - the actual type of AmetysObjects.

Returns:

the children or an empty AmetysObjectIterable.

Throws:

AmetysRepositoryException - if an error occurs.

getDefinition

public ModelItem getDefinition(String dataPath)

Description copied from interface: Content

Retrieves the definition of the data at the given path

Specified by:

getDefinition in interface Content

Parameters:

dataPath - path of the data

Returns:

the definition of the data. null if there is no item defined at this path. TODO NEWATTRIBUTEAPI_CONTENT: Move this method in ModelAwareDataHolder

getDataHolder

public ModelAwareDataHolder getDataHolder()

Description copied from interface: DataAwareAmetysObject

Returns the DataHolder of this AmetysObject.

Specified by:

getDataHolder in interface DataAwareAmetysObject

Specified by:

getDataHolder in interface ModelAwareDataAwareAmetysObject

Returns:

the DataHolder of this AmetysObject

getModels

protected List<Model> getModels()

Retrieves the model of the content as an array

Returns:

the model of the content

addReaction

public void addReaction(UserIdentity user,
                        ReactionableObject.ReactionType reactionType)

Description copied from interface: ReactionableObject

Add the user reaction

Specified by:

addReaction in interface ReactionableObject

Parameters:

user - the user

reactionType - the reaction type

removeReaction

public void removeReaction(UserIdentity user,
                           ReactionableObject.ReactionType reactionType)

Description copied from interface: ReactionableObject

Remove the user reaction

Specified by:

removeReaction in interface ReactionableObject

Parameters:

user - the user

reactionType - the reaction type

getReactionUsers

public List<UserIdentity> getReactionUsers(ReactionableObject.ReactionType reactionType)

Description copied from interface: ReactionableObject

Get the list of users who react

Specified by:

getReactionUsers in interface ReactionableObject

Parameters:

reactionType - the reaction type

Returns:

the list of users