org.ametys.cms.tag.jcr

Class JCRTag

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

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

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

org.ametys.cms.tag.jcr.JCRTag

All Implemented Interfaces:

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

public class JCRTag
extends DefaultTraversableAmetysObject<TagFactory>

AmetysObject for storing tag informations.

Field Summary

Fields

Modifier and Type	Field and Description
private static String	__METADATA_DESC Constants for description metadata.
private static String	__METADATA_TARGET Constants for type metadata.
private static String	__METADATA_TITLE Constants for title metadata.
private static String	__METADATA_VISIBILITY Constants for visibility metadata.

Constructor Summary

Constructors

Constructor and Description
JCRTag(Node node, String parentPath, TagFactory factory) Creates a Tag.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Retrieves the description.
String	getTargetType() Retrieves the target type.
String	getTitle() Retrieves the title.
Tag.TagVisibility	getVisibility() Retrieves the visibility type.
void	setDescription(String description) Set the description.
void	setTargetType(TagTargetType target) Set the target type.
void	setTitle(String title) Set the title.
void	setVisibility(Tag.TagVisibility visibility) Set the visibility type.

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

addAllowedGroups, addAllowedProfilesForAnonymous, addAllowedProfilesForAnyConnectedUser, addAllowedUsers, addDeniedGroups, addDeniedProfilesForAnonymous, addDeniedProfilesForAnyConnectedUser, addDeniedUsers, createChild, getAllowedGroups, getAllowedProfilesForAnonymous, getAllowedProfilesForAnyConnectedUser, getAllowedProfilesForGroups, getAllowedProfilesForUser, getAllowedProfilesForUsers, getAllowedUsers, getChild, getChildren, getDeniedGroups, getDeniedProfilesForAnonymous, getDeniedProfilesForAnyConnectedUser, getDeniedProfilesForGroups, getDeniedProfilesForUser, getDeniedProfilesForUsers, getDeniedUsers, hasChild, 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.jcr.JCRAmetysObject

getNode

Methods inherited from interface org.ametys.plugins.repository.metadata.ModifiableMetadataAwareAmetysObject

getMetadataHolder

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_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_VISIBILITY

private static final String __METADATA_VISIBILITY

Constants for visibility metadata.

See Also:

Constant Field Values

__METADATA_TARGET

private static final String __METADATA_TARGET

Constants for type metadata.

See Also:

Constant Field Values

Constructor Detail

JCRTag

public JCRTag(Node node,
              String parentPath,
              TagFactory factory)

Creates a Tag.

Parameters:

node - the node backing this AmetysObject.

parentPath - the parent path in the Ametys hierarchy.

factory - the TagFactory 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.

getVisibility

public Tag.TagVisibility getVisibility()
                                throws AmetysRepositoryException

Retrieves the visibility type.

Returns:

the visibility type.

Throws:

AmetysRepositoryException - if an error occurs.

setVisibility

public void setVisibility(Tag.TagVisibility visibility)
                   throws AmetysRepositoryException

Set the visibility type.

Parameters:

visibility - the visibility type.

Throws:

AmetysRepositoryException - if an error occurs.

getTargetType

public String getTargetType()
                     throws AmetysRepositoryException

Retrieves the target type.

Returns:

the target type.

Throws:

AmetysRepositoryException - if an error occurs.

setTargetType

public void setTargetType(TagTargetType target)
                   throws AmetysRepositoryException

Set the target type.

Parameters:

target - the target type.

Throws:

AmetysRepositoryException - if an error occurs.