org.ametys.web.repository.site

Interface SiteType

All Known Implementing Classes:

DefaultSiteType, ProjectWorkspaceSiteType

public interface SiteType

This class represents a type of site.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SITE_TYPE_ID Constant for the default site type

Method Summary

Modifier and Type	Method and Description
I18nizableText	getDescription() Retrieves the description of the site type.
String	getIconGlyph() Retrieves the CSS class to use for glyph icon
String	getId() Retrieves the id of the site type.
I18nizableText	getLabel() Retrieves the label of the site 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.
String	getName() Retrieves the name of the site type.
String	getPluginName() Retrieves the name of the plugin declaring this site type.
String	getSmallIcon() Retrieves the URL of the icon without the context path.
default boolean	isPrivateType() Indicates if this site type is private. Private site type are usually not shown when the types are enumerated (e.g.
default boolean	siteInitiallyRestricted() Initially restricted site will not be accessible by default, which means that no READER profile will be affected on pages, contents etc...

Field Detail

DEFAULT_SITE_TYPE_ID

static final String DEFAULT_SITE_TYPE_ID

Constant for the default site type

See Also:

Constant Field Values

Method Detail

getId

String getId()

Retrieves the id of the site type.

Returns:

the id.

getName

String getName()

Retrieves the name of the site type.

Returns:

the name.

getPluginName

String getPluginName()

Retrieves the name of the plugin declaring this site type.

Returns:

the name of the plugin.

getLabel

I18nizableText getLabel()

Retrieves the label of the site type.

Returns:

the label.

getDescription

I18nizableText getDescription()

Retrieves the description of the site type.

Returns:

the description.

getIconGlyph

String getIconGlyph()

Retrieves the CSS class to use for glyph 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.

isPrivateType

default boolean isPrivateType()

Indicates if this site type is private.
Private site type are usually not shown when the types are enumerated (e.g. during site creation)

Returns:

true if private

siteInitiallyRestricted

default boolean siteInitiallyRestricted()

Initially restricted site will not be accessible by default, which means that no READER profile will be affected on pages, contents etc...

Returns:

true if initially restricted