org.ametys.cms.contenttype

Interface ContentType

All Superinterfaces:

ContentTypeDescriptor, MetadataDefinitionHolder

All Known Implementing Classes:

AutomaticContentType, DefaultContentType, HTMLContentType, PostContentType, WebContentType

public interface ContentType
extends ContentTypeDescriptor, MetadataDefinitionHolder

This class represents a type of content.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAG_MIXIN Tag for simple content type
static String	TAG_PRIVATE Tag for private content type
static String	TAG_SIMPLE Tag for simple content type

Method Summary

Modifier and Type	Method and Description
boolean	canRead(Content content, MetadataDefinition metadataDef) Determine whether a metadata can be read at this time.
boolean	canWrite(Content content, MetadataDefinition metadataDef) Determine whether a metadata can be written at this time.
Map<String,Object>	getAdditionalData(Content content) Get the additional data relative to its ContentType.
List<ContentValidator>	getGlobalValidators() Retrieves the potential global validators.
IndexingModel	getIndexingModel() Get the indexing model
MetadataDefinition	getMetadataDefinitionByPath(String metadataPath) Retrieves the definition of a given metadata by its path.
RichTextUpdater	getRichTextUpdater() Retrieves the RichText updater
String	getRight() Get the right needed to create a content of this type.
Set<String>	getTags() Get the registered tags for this content types
boolean	hasMetadataDefinition(String metadataName) Determines if the definition of a given metadata exists.
boolean	hasTag(String tagName) Determines if the content type has the given tag
boolean	isAbstract() Get whether the content type is abstract, i.e.
boolean	isMixin() Get whether the content type is a mixin, i.e.
boolean	isPrivate() Get whether the content type is private, i.e.
boolean	isSimple() Get whether the content type is simple, i.e.
void	postInitialize() Called by the extension point when the content type hierarchy has been computed.
void	saxContentTypeAdditionalData(ContentHandler contentHandler, Content content) SAX the additional content data linked to its ContentType These additional data will be available in content view

Methods inherited from interface org.ametys.cms.contenttype.ContentTypeDescriptor

getCategory, getCSSFiles, getDefaultTitle, getDescription, getEditionMetadataSetNames, getIconDecorator, getIconGlyph, getId, getLabel, getLargeIcon, getMediumIcon, getMetadataSetForEdition, getMetadataSetForView, getPluginName, getSmallIcon, getSupertypeIds, getViewMetadataSetNames

Methods inherited from interface org.ametys.cms.contenttype.MetadataDefinitionHolder

getMetadataDefinition, getMetadataNames

Field Detail

TAG_PRIVATE

static final String TAG_PRIVATE

Tag for private content type

See Also:

Constant Field Values

TAG_SIMPLE

static final String TAG_SIMPLE

Tag for simple content type

See Also:

Constant Field Values

TAG_MIXIN

static final String TAG_MIXIN

Tag for simple content type

See Also:

Constant Field Values

Method Detail

postInitialize

void postInitialize()
             throws Exception

Called by the extension point when the content type hierarchy has been computed. Can be used to do more initialization, checks, ...

Throws:

Exception - if an error occurs of if an additional check fails.

getGlobalValidators

List<ContentValidator> getGlobalValidators()

Retrieves the potential global validators.

Returns:

the global validators or an empty List if none.

getRichTextUpdater

RichTextUpdater getRichTextUpdater()

Retrieves the RichText updater

Returns:

the RichText updater or null if none.

getIndexingModel

IndexingModel getIndexingModel()

Get the indexing model

Returns:

the indexing model

getMetadataDefinitionByPath

MetadataDefinition getMetadataDefinitionByPath(String metadataPath)

Retrieves the definition of a given metadata by its path.

Parameters:

metadataPath - the metadata path, separated by '/'

Returns:

the metadata definition or null if not found

hasMetadataDefinition

boolean hasMetadataDefinition(String metadataName)

Determines if the definition of a given metadata exists.

Parameters:

metadataName - the metadata name.

Returns:

true if the metadata definition exists

canRead

boolean canRead(Content content,
                MetadataDefinition metadataDef)
         throws AmetysRepositoryException

Determine whether a metadata can be read at this time.

Parameters:

metadataDef - the metadata definition

content - The content where metadata is to be read on. Can be null, on content creation.

Returns:

true if the current user is allowed to read the metadata of this content.

Throws:

AmetysRepositoryException - if an error occurs while accessing the content.

canWrite

boolean canWrite(Content content,
                 MetadataDefinition metadataDef)
          throws AmetysRepositoryException

Determine whether a metadata can be written at this time.

Parameters:

metadataDef - the metadata definition

content - The content where metadata is to be written on. Can be null, on content creation.

Returns:

true if the current user is allowed to write the metadata of this content.

Throws:

AmetysRepositoryException - if an error occurs while accessing the content.

getTags

Set<String> getTags()

Get the registered tags for this content types

Returns:

the tags

hasTag

boolean hasTag(String tagName)

Determines if the content type has the given tag

Parameters:

tagName - The tag name

Returns:

true if the content type is tagged with the given tag name

isPrivate

boolean isPrivate()

Get whether the content type is private, i.e. should not be created by the regular content interface.

Returns:

true if the content is private, false if it is public.

isSimple

boolean isSimple()

Get whether the content type is simple, i.e. should contains only simple metadata type to be edited in a grid.

Returns:

true if the content is simple, false otherwise

isAbstract

boolean isAbstract()

Get whether the content type is abstract, i.e. should not be created by the regular content interface.

Returns:

true if the content is abstract, false otherwise.

isMixin

boolean isMixin()

Get whether the content type is a mixin, i.e. should used to add metadata to a existing content.

Returns:

true if the content is mixin, false otherwise.

getRight

String getRight()

Get the right needed to create a content of this type.

Returns:

the right needed to create a content of this type. If null is returned, no right is needed.

saxContentTypeAdditionalData

void saxContentTypeAdditionalData(ContentHandler contentHandler,
                                  Content content)
                           throws AmetysRepositoryException,
                                  SAXException

SAX the additional content data linked to its ContentType These additional data will be available in content view

Parameters:

contentHandler - The handler to SAX into

content - The content

Throws:

AmetysRepositoryException - if an error occurs while accessing the content.

SAXException - if an error occurs while SAXing

getAdditionalData

Map<String,Object> getAdditionalData(Content content)

Get the additional data relative to its ContentType. These additional data are delivered to client side.

Parameters:

content - The content

Returns:

the additional properties in a Map