Package com.coremedia.blueprint.common.contentbeans

Interface CMSymbol

All Superinterfaces:
com.coremedia.objectserver.dataviews.AssumesIdentity, CMLocalized, CMObject, com.coremedia.objectserver.beans.ContentBean
All Known Subinterfaces:
CMViewtype
public interface CMSymbol extends CMLocalized

CMSymbol documents are constants, used in terms of enumeration values.

Represents the document type CMSymbol.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DESCRIPTION
    Name of the document property 'description'.
    static final String
    ICON
    Name of the document property 'icon'.
    static final String
    NAME
    Name of the ContentType 'CMSymbol'.

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

    LOCALE, MASTER, 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 CMSymbol>>
    getAspectByName()
    Deprecated.
    since 1907.1; Implement optional features as extensions.
    List<? extends com.coremedia.cae.aspect.Aspect<? extends CMSymbol>>
    getAspects()
    Deprecated.
    since 1907.1; Implement optional features as extensions.
    String
    getDescription()
    Returns the value of the document property DESCRIPTION.
    com.coremedia.cap.common.Blob
    getIcon()
    Returns the value of the CMSymbol document property ICON.
    String
    getName()
    Returns the name of this symbol.

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

    assumeIdentity

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

    getCountry, getLang, getLocale, getLocalizations, getMaster, 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 CMSymbol>> 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 CMSymbol>> 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

    • getDescription

      String getDescription()
      Returns the value of the document property DESCRIPTION.
      Returns:
      the value of the document property DESCRIPTION

    • getName

      String getName()
      Returns the name of this symbol.
      Returns:
      name of this symbol

    • getIcon

      com.coremedia.cap.common.Blob getIcon()
      Returns the value of the CMSymbol document property ICON.
      Returns:
      the value of the CMSymbol document property ICON or null