Package com.coremedia.blueprint.common.contentbeans

Interface CMSite

All Superinterfaces:
com.coremedia.objectserver.dataviews.AssumesIdentity, CMLocalized, CMObject, com.coremedia.objectserver.beans.ContentBean
public interface CMSite extends CMLocalized

Helper document: All root navigations must be referred to by a CMSite. This is an internal optimization to find the root navigations quickly.

Represents the document type CMSite.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ID
    Name of the document property 'id'.
    static final String
    MASTER
    Name of the document property 'master'.
    static final String
    NAME
    Name of the ContentType 'CMSite'.
    static final String
    ROOT
    Name of the document property 'root'.

    Fields inherited from interface com.coremedia.blueprint.common.contentbeans.CMLocalized

    LOCALE, MASTER_VERSION

    Fields inherited from interface com.coremedia.objectserver.beans.ContentBean

    METADATA_PROPERTIES_PREFIX

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,? extends com.coremedia.cae.aspect.Aspect<? extends CMSite>>
    getAspectByName()
    Deprecated.
    since 1907.1; Implement optional features as extensions.
    List<? extends com.coremedia.cae.aspect.Aspect<? extends CMSite>>
    getAspects()
    Deprecated.
    since 1907.1; Implement optional features as extensions.
    String
    getId()
    Returns the value of the document property ID.
    CMSite
    getMaster()
    Returns the value of the document property MASTER.
    CMNavigation
    getRoot()
    Returns the value of the document property ROOT.

    Methods inherited from interface com.coremedia.objectserver.dataviews.AssumesIdentity

    assumeIdentity

    Methods inherited from interface com.coremedia.blueprint.common.contentbeans.CMLocalized

    getCountry, getLang, getLocale, getLocalizations, getMasterVersion, getVariantsByLocale

    Methods inherited from interface com.coremedia.blueprint.common.contentbeans.CMObject

    getAspectsProvider, getContentId, getUuid

    Methods inherited from interface com.coremedia.objectserver.beans.ContentBean

    getContent, getContentBeanFactory

  • Field Details

  • Method Details

    • getAspectByName

      @Deprecated Map<String,? extends com.coremedia.cae.aspect.Aspect<? extends CMSite>> getAspectByName()
      Deprecated.
      since 1907.1; Implement optional features as extensions.
      Description copied from interface: CMObject

      Returns a Map from aspectIDs to Aspects. AspectIDs consists of an aspectname with a prefix which identifies the plugin provider.

      Usage:

      Access an aspect named osmPlugin.

      Freemarker:
      
 <#assign osmSocialPlugin=self.aspectByName['osmPlugin'] />
      JSP:
      
 <c:set var="osmSocialPlugin" value="${self.aspectByName['osmPlugin']}"/>
      Specified by:
      getAspectByName in interface CMLocalized
      Specified by:
      getAspectByName in interface CMObject
      Returns:
      a Map from aspectIDs to Aspects

    • getAspects

      @Deprecated List<? extends com.coremedia.cae.aspect.Aspect<? extends CMSite>> getAspects()
      Deprecated.
      since 1907.1; Implement optional features as extensions.
      Description copied from interface: CMObject

      Returns a list of all Aspect from all available PlugIns that are registered to this contentbean.

      Usage:

      Add all aspects with view asHead.

      Freemarker:
      
 <#list self.aspects as aspect>
   <@cm.include self=aspect view="asHeader"/>
 </#list>
      JSP:
      
 <c:forEach items="${self.aspects}" var="aspect">
   <cm:include self="${aspect}" view="asHeader"/>
 </c:forEach>
      Specified by:
      getAspects in interface CMLocalized
      Specified by:
      getAspects in interface CMObject
      Returns:
      a list of Aspects

    • getRoot

      CMNavigation getRoot()
      Returns the value of the document property ROOT.
      Returns:
      the value of the document property ROOT

    • getId

      String getId()
      Returns the value of the document property ID.
      Returns:
      the value of the document property ID

    • getMaster

      CMSite getMaster()
      Returns the value of the document property MASTER.
      Specified by:
      getMaster in interface CMLocalized
      Returns:
      a CMSite object or null if no master site exists