Package com.coremedia.blueprint.common.contentbeans

Interface CMChannel

All Superinterfaces:

com.coremedia.objectserver.dataviews.AssumesIdentity, BelowRootNavigation, CMContext, CMHasContexts, CMLinkable, CMLocalized, CMNavigation, CMObject, CMTeasable, com.coremedia.objectserver.beans.ContentBean, com.coremedia.blueprint.common.feeds.FeedSource<CMLinkable>, HasPageGrid, HasViewTypeName, com.coremedia.blueprint.base.links.KnowsVanityUrls, Linkable, Navigation, com.coremedia.blueprint.common.datevalidation.ValidityPeriod

public interface CMChannel
extends CMContext, com.coremedia.blueprint.base.links.KnowsVanityUrls

A channel is a hierarchical navigation entity with "booked content". The booked content is divided into several linklists which represent the areas of a page. You are encouraged to change these content linklists according to your particular page layout.

Some parts of a page are typically the same for many different channels, e.g. headers and footers with company information, ad blocks, ...
Therefore the implementation bean of CMChannel supports a fallback to the parent channel for header and footer.

If a channel has several parents (i.e. referenced by the children property of other channels) an arbitrary parent is chosen to inherit from. I.e. channels with several parents (not recommended anyway) should bring their own properties to ensure a reliable behaviour.

Represents the document type CMChannel.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FOOTER	Deprecated. since 2110; The property 'footer' is not used any longer, so this constant is obsolete.
static final String	HEADER	Deprecated. since 2110; The property 'header' is not used any longer, so this constant is obsolete.
static final String	NAME	Name of the ContentType 'CMChannel'.

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

CONTEXTS

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

EXTERNALLY_DISPLAYED_DATE, HTML_DESCRIPTION, HTML_TITLE, KEYWORDS, LINKED_SETTINGS, LOCAL_SETTINGS, LOCATION_TAXONOMY, RESOURCE_BUNDLES2, SEGMENT, SUBJECT_TAXONOMY, TITLE, VALID_FROM, VALID_TO, VIEWTYPE

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

LOCALE, MASTER, MASTER_VERSION

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

CHILDREN, CSS, FAVICON, HIDDEN, HIDDEN_IN_SITEMAP, JAVA_SCRIPT, PLACEMENT, THEME

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

AUTHORS, DETAIL_TEXT, NOT_SEARCHABLE, PICTURES, RELATED, TEASER_OVERLAY_SETTINGS_STRUCT_NAME, TEASER_OVERLAY_SETTINGS_STYLE_SUB_STRUCT_NAME, TEASER_SETTINGS_STRUCT_NAME, TEASER_TEXT, TEASER_TITLE

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 CMChannel>>	getAspectByName()	Deprecated. since 1907.1; Implement optional features as extensions.
List<? extends com.coremedia.cae.aspect.Aspect<? extends CMChannel>>	getAspects()	Deprecated. since 1907.1; Implement optional features as extensions.
List<? extends Linkable>	getFooter()	Deprecated. since 2110; Obsolete, all contents of a page are controlled in the page grid meanwhile.
List<? extends Linkable>	getHeader()	Deprecated. since 2110; Obsolete, all contents of a page are controlled in the page grid meanwhile.
Collection<? extends CMChannel>	getLocalizations()	Returns the Locale specific variants of this CMLocalized
CMChannel	getMaster()	Returns the value of the document property CMLocalized.MASTER.
Map<Locale,? extends CMChannel>	getVariantsByLocale()	Returns the variants of this CMLocalized indexed by their Locale

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

assumeIdentity

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

getRootNavigations

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

getContexts, getExternallyDisplayedDate, getHtmlDescription, getHtmlTitle, getKeywords, getLinkedSettings, getLocalSettings, getLocationTaxonomy, getResourceBundles2, getSubjectTaxonomy, getTitle, getValidFrom, getValidTo, getViewtype, isOpenInNewTab

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

getCountry, getLang, getLocale, getMasterVersion

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

getCss, getFavicon, getJavaScript, getPlacement

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

getAspectsProvider, getContentId, getUuid

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

fetchMediaWithRecursionDetection, getAuthors, getCallToActionSettings, getDetailText, getFirstMedia, getMedia, getPicture, getPictures, getRelated, getRelatedAll, getRelatedAllByType, getRelatedByReferrers, getRelatedBySimilarTaxonomies, getRelatedImplicitly, getRelatedImplicitlyByType, getTarget, getTeaserOverlaySettings, getTeaserOverlayStyle, getTeaserSettings, getTeaserText, getTeaserTitle, getTextAsParagraphs, isNotSearchable

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

getContent, getContentBeanFactory

Methods inherited from interface com.coremedia.blueprint.common.feeds.FeedSource

getFeedDescription, getFeedFormat, getFeedItems, getFeedTitle, getItemsFlattened, getPublishedDate

Methods inherited from interface com.coremedia.blueprint.common.layout.HasPageGrid

getContext, getPageGrid

Methods inherited from interface com.coremedia.blueprint.common.navigation.HasViewTypeName

getViewTypeName

Methods inherited from interface com.coremedia.blueprint.base.links.KnowsVanityUrls

getVanityUrlMapper

Methods inherited from interface com.coremedia.blueprint.common.navigation.Linkable

getLocale, getSegment

Methods inherited from interface com.coremedia.blueprint.common.navigation.Navigation

getAspectsProvider, getChildren, getCodeResourcesTreeRelation, getContext, getNavigationPathList, getParentNavigation, getRootNavigation, getSitemapChildren, getTheme, getVisibleChildren, isHidden, isHiddenInSitemap, isRoot

Field Details

NAME

static final String NAME

Name of the ContentType 'CMChannel'.

See Also:

• Constant Field Values

HEADER

@Deprecated
static final String HEADER

Deprecated.

since 2110; The property 'header' is not used any longer, so this constant is obsolete.

Name of the document property 'header'.

See Also:

• Constant Field Values

FOOTER

@Deprecated
static final String FOOTER

Deprecated.

since 2110; The property 'footer' is not used any longer, so this constant is obsolete.

Name of the document property 'footer'.

See Also:

• Constant Field Values

Method Details

getMaster

CMChannel getMaster()

Returns the value of the document property CMLocalized.MASTER.

Specified by:

getMaster in interface CMContext

Specified by:

getMaster in interface CMHasContexts

Specified by:

getMaster in interface CMLinkable

Specified by:

getMaster in interface CMLocalized

Specified by:

getMaster in interface CMNavigation

Specified by:

getMaster in interface CMTeasable

Returns:

a CMChannel object

getVariantsByLocale

Map<Locale,? extends CMChannel> getVariantsByLocale()

Description copied from interface: CMLocalized

Returns the variants of this CMLocalized indexed by their Locale

Specified by:

getVariantsByLocale in interface CMContext

Specified by:

getVariantsByLocale in interface CMHasContexts

Specified by:

getVariantsByLocale in interface CMLinkable

Specified by:

getVariantsByLocale in interface CMLocalized

Specified by:

getVariantsByLocale in interface CMNavigation

Specified by:

getVariantsByLocale in interface CMTeasable

Returns:

the variants of this CMLocalized indexed by their Locale

getLocalizations

Collection<? extends CMChannel> getLocalizations()

Description copied from interface: CMLocalized

Returns the Locale specific variants of this CMLocalized

Usage:

Add elements for each variant excluding self (self is of type Page in this example).

Freemarker:

 <#if (self.content.localizations)?has_content>
   <#assign localizations=self.content.localizations![] />
   <#list localizations as localization>
     <#if localization.locale != self.content.locale>
       <link rel="alternate" ... />
     </#if>
   </#list>
 </#if>
 

JSP:

 <c:set var="locales" value="${self.content.localizations}"/>
 <c:if test="${not empty locales}">
   <c:forEach var="localization" items="${locales}">
     <c:if test="${localization.locale != self.content.locale}">
       <cm:link var="localitationLink" target="${localization}"/>
       <link rel="alternate" ... />
     </c:if>
   </c:forEach>
 </c:if>
 

Specified by:

getLocalizations in interface CMContext

Specified by:

getLocalizations in interface CMHasContexts

Specified by:

getLocalizations in interface CMLinkable

Specified by:

getLocalizations in interface CMLocalized

Specified by:

getLocalizations in interface CMNavigation

Specified by:

getLocalizations in interface CMTeasable

Returns:

the Locale specific variants of this CMLocalized

getAspectByName

@Deprecated
Map<String,? extends com.coremedia.cae.aspect.Aspect<? extends CMChannel>> 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 CMContext

Specified by:

getAspectByName in interface CMHasContexts

Specified by:

getAspectByName in interface CMLinkable

Specified by:

getAspectByName in interface CMLocalized

Specified by:

getAspectByName in interface CMNavigation

Specified by:

getAspectByName in interface CMObject

Specified by:

getAspectByName in interface CMTeasable

Returns:

a Map from aspectIDs to Aspects

getAspects

@Deprecated
List<? extends com.coremedia.cae.aspect.Aspect<? extends CMChannel>> 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 CMContext

Specified by:

getAspects in interface CMHasContexts

Specified by:

getAspects in interface CMLinkable

Specified by:

getAspects in interface CMLocalized

Specified by:

getAspects in interface CMNavigation

Specified by:

getAspects in interface CMObject

Specified by:

getAspects in interface CMTeasable

Returns:

a list of Aspects

getHeader

@Deprecated
List<? extends Linkable> getHeader()

Deprecated.

since 2110; Obsolete, all contents of a page are controlled in the page grid meanwhile.

Returns the value of the document property HEADER.

Returns:

a list of CMLinkable objects

getFooter

@Deprecated
List<? extends Linkable> getFooter()

Deprecated.

since 2110; Obsolete, all contents of a page are controlled in the page grid meanwhile.

Returns the value of the document property FOOTER.

Returns:

a list of CMLinkable objects