Package org.ametys.web.repository.site

Interface SiteType

All Superinterfaces:
Model, ModelItemAccessor, ModelItemContainer
All Known Implementing Classes:
DefaultSiteType, ProjectWorkspaceSiteType
public interface SiteType extends Model
This class represents a type of site.

  • Field Details

  • Method Details

    • 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.

    • getModelItems

      Collection<ElementDefinition> getModelItems()
      Description copied from interface: ModelItemAccessor
      Retrieves all the model items of this accessor
      Specified by:
      getModelItems in interface ModelItemAccessor
      Returns:
      the model items

    • getModelItem

      default ElementDefinition getModelItem(String itemPath) throws UndefinedItemPathException
      Description copied from interface: ModelItemAccessor
      Retrieves the model item at given path
      Specified by:
      getModelItem in interface ModelItemAccessor
      Parameters:
      itemPath - the item path
      Returns:
      the model item.
      Throws:
      UndefinedItemPathException - if there is no item defined at the given path

    • getView

      View getView()
      Retrieves the site type view, built from site parameter categories and groups
      Returns:
      the site type view

    • 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