org.ametys.cms.contenttype

Interface ContentTypeDescriptor

All Known Subinterfaces:

ContentType

All Known Implementing Classes:

AbstractContentTypeDescriptor, AutomaticContentType, DefaultContentType, DynamicContentTypeDescriptor, HTMLContentType, PostContentType, ThesaurusItemContentType, WebContentType

public interface ContentTypeDescriptor

This class represents a descriptor for content type

Method Summary

Modifier and Type	Method and Description
I18nizableText	getCategory() Retrieves the category of the content type.
List<ClientSideElement.ScriptFile>	getCSSFiles() Returns the list of CSS files needed to correctly display the content's in BO, such as the content's icon
I18nizableText	getDefaultTitle() Retrieves the default title of the content type.
I18nizableText	getDescription() Retrieves the description of the content type.
Set<String>	getEditionMetadataSetNames(boolean includeInternal) Returns all names of "edition" metadataSets.
String	getIconDecorator() Retrieves the CSS class to use for decorator above the main icon
String	getIconGlyph() Retrieves the CSS class to use for glyph icon
String	getId() Retrieves the id of the content type.
I18nizableText	getLabel() Retrieves the label of the content type.
String	getLargeIcon() Retrieves the URL of the icon without the context path.
String	getMediumIcon() Retrieves the URL of the icon without the context path.
MetadataSet	getMetadataSetForEdition(String metadataSetName) Retrieves the metadata set name for edition.
MetadataSet	getMetadataSetForView(String metadataSetName) Retrieves the metadata set name for view.
String	getPluginName() Retrieves the name of the plugin declaring this content type.
String	getSmallIcon() Retrieves the URL of the icon without the context path.
String[]	getSupertypeIds() Retrieves the super type's ids.
Set<String>	getViewMetadataSetNames(boolean includeInternal) Returns all names of "view" metadataSets.

Method Detail

getId

String getId()

Retrieves the id of the content type.

Returns:

the id.

getPluginName

String getPluginName()

Retrieves the name of the plugin declaring this content type.

Returns:

the name of the plugin.

getLabel

I18nizableText getLabel()

Retrieves the label of the content type.

Returns:

the label.

getDescription

I18nizableText getDescription()

Retrieves the description of the content type.

Returns:

the description.

getDefaultTitle

I18nizableText getDefaultTitle()

Retrieves the default title of the content type.

Returns:

the default title.

getCategory

I18nizableText getCategory()

Retrieves the category of the content type.

Returns:

the category.

getSupertypeIds

String[] getSupertypeIds()

Retrieves the super type's ids.

Returns:

the super type's ids, or empty if this content type doesn't extend a specific content type.

getIconGlyph

String getIconGlyph()

Retrieves the CSS class to use for glyph icon

Returns:

the glyph name.

getIconDecorator

String getIconDecorator()

Retrieves the CSS class to use for decorator above the main icon

Returns:

the glyph name.

getSmallIcon

String getSmallIcon()

Retrieves the URL of the icon without the context path.

Returns:

the icon URL for the small image 16x16.

getMediumIcon

String getMediumIcon()

Retrieves the URL of the icon without the context path.

Returns:

the icon URL for the medium sized image 32x32.

getLargeIcon

String getLargeIcon()

Retrieves the URL of the icon without the context path.

Returns:

the icon URL for the large image 48x48.

getViewMetadataSetNames

Set<String> getViewMetadataSetNames(boolean includeInternal)

Returns all names of "view" metadataSets.

Parameters:

includeInternal - if the result should include internal metadataSets.

Returns:

all names of "view" metadataSets.

getEditionMetadataSetNames

Set<String> getEditionMetadataSetNames(boolean includeInternal)

Returns all names of "edition" metadataSets.

Parameters:

includeInternal - if the result should include internal metadataSets.

Returns:

all names of "edition" metadataSets.

getMetadataSetForView

MetadataSet getMetadataSetForView(String metadataSetName)

Retrieves the metadata set name for view.

Parameters:

metadataSetName - the metadata set name.

Returns:

the metadata definition.

getMetadataSetForEdition

MetadataSet getMetadataSetForEdition(String metadataSetName)

Retrieves the metadata set name for edition.

Parameters:

metadataSetName - the metadata set name.

Returns:

the metadata set.

getCSSFiles

List<ClientSideElement.ScriptFile> getCSSFiles()

Returns the list of CSS files needed to correctly display the content's in BO, such as the content's icon

Returns:

The list of CSS files needed. Must not be null.