Package org.ametys.plugins.newsletter.category

Class JCRCategory

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

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

org.ametys.plugins.repository.jcr.DefaultTraversableAmetysObject<CategoryFactory>

org.ametys.plugins.newsletter.category.JCRCategory

All Implemented Interfaces:

ACLAmetysObject, AmetysObject, JCRAmetysObject, JCRTraversableAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, ModifiableTraversableAmetysObject, RemovableAmetysObject, TraversableAmetysObject

public class JCRCategory
extends DefaultTraversableAmetysObject<CategoryFactory>

AmetysObject for storing tag informations.

Field Summary

Fields

Modifier and Type	Field	Description
private static String	__AUTOMATIC_IDS	Constants for automatic newsletter ids.
private static String	__METADATA_DESC	Constants for description metadata.
private static String	__METADATA_TEMPLATE	Constants for template metadata.
private static String	__METADATA_TITLE	Constants for title metadata.

Constructor Summary

Constructors

Constructor	Description
JCRCategory(Node node, String parentPath, CategoryFactory factory)	Creates a JCRCategory.

Method Summary

Modifier and Type	Method	Description
Collection<String>	getAutomaticIds()	Retrieves the template name.
String	getDescription()	Retrieves the description.
String	getLang()	Returns the language
String	getSiteName()	Get the site name
String	getTemplate()	Retrieves the template name.
String	getTitle()	Retrieves the title.
void	setAutomaticIds(Collection<String> autoIds)	Set the template.
void	setDescription(String description)	Set the description.
void	setTemplate(String templateName)	Set the template.
void	setTitle(String title)	Set the title.

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

addAllowedGroups, addAllowedProfilesForAnonymous, addAllowedProfilesForAnyConnectedUser, addAllowedUsers, addDeniedGroups, addDeniedProfilesForAnonymous, addDeniedProfilesForAnyConnectedUser, addDeniedUsers, createChild, disallowInheritance, getChild, getChildren, getProfilesForAnonymousAndAnyConnectedUser, getProfilesForGroups, getProfilesForUsers, hasChild, isInheritanceDisallowed, removeAllowedGroups, removeAllowedGroups, removeAllowedProfilesForAnonymous, removeAllowedProfilesForAnyConnectedUser, removeAllowedUsers, removeAllowedUsers, removeDeniedGroups, removeDeniedGroups, removeDeniedProfilesForAnonymous, removeDeniedProfilesForAnyConnectedUser, removeDeniedUsers, removeDeniedUsers

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

_getFactory, _invalidateName, _invalidateParentPath, getId, getMetadataHolder, getName, getNode, 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.AmetysObject

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

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.metadata.ModifiableMetadataAwareAmetysObject

getMetadataHolder

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

remove

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

getChildAt, getChildPosition

Field Detail

__METADATA_TITLE

private static final String __METADATA_TITLE

Constants for title metadata.

See Also:

Constant Field Values

__METADATA_DESC

private static final String __METADATA_DESC

Constants for description metadata.

See Also:

Constant Field Values

__METADATA_TEMPLATE

private static final String __METADATA_TEMPLATE

Constants for template metadata.

See Also:

Constant Field Values

__AUTOMATIC_IDS

private static final String __AUTOMATIC_IDS

Constants for automatic newsletter ids.

See Also:

Constant Field Values

Constructor Detail

JCRCategory

public JCRCategory(Node node,
                   String parentPath,
                   CategoryFactory factory)

Creates a JCRCategory.

Parameters:

node - the node backing this AmetysObject.

parentPath - the parent path in the Ametys hierarchy.

factory - the CategoryFactory which creates the AmetysObject.

Method Detail

getTitle

public String getTitle()
                throws AmetysRepositoryException

Retrieves the title.

Returns:

the title.

Throws:

AmetysRepositoryException - if an error occurs.

setTitle

public void setTitle(String title)
              throws AmetysRepositoryException

Set the title.

Parameters:

title - the title.

Throws:

AmetysRepositoryException - if an error occurs.

getDescription

public String getDescription()
                      throws AmetysRepositoryException

Retrieves the description.

Returns:

the description.

Throws:

AmetysRepositoryException - if an error occurs.

setDescription

public void setDescription(String description)
                    throws AmetysRepositoryException

Set the description.

Parameters:

description - the description.

Throws:

AmetysRepositoryException - if an error occurs.

getTemplate

public String getTemplate()
                   throws AmetysRepositoryException

Retrieves the template name.

Returns:

the template name.

Throws:

AmetysRepositoryException - if an error occurs.

setTemplate

public void setTemplate(String templateName)
                 throws AmetysRepositoryException

Set the template.

Parameters:

templateName - the template.

Throws:

AmetysRepositoryException - if an error occurs.

getAutomaticIds

public Collection<String> getAutomaticIds()
                                   throws AmetysRepositoryException

Retrieves the template name.

Returns:

the template name.

Throws:

AmetysRepositoryException - if an error occurs.

setAutomaticIds

public void setAutomaticIds(Collection<String> autoIds)
                     throws AmetysRepositoryException

Set the template.

Parameters:

autoIds - the template.

Throws:

AmetysRepositoryException - if an error occurs.

getSiteName

public String getSiteName()

Get the site name

Returns:

The site name

getLang

public String getLang()

Returns the language

Returns:

the language