Interface CMDownload
- All Superinterfaces:
com.coremedia.objectserver.dataviews.AssumesIdentity
,BelowRootNavigation
,CMHasContexts
,CMLinkable
,CMLocalized
,CMObject
,CMTeasable
,com.coremedia.objectserver.beans.ContentBean
,HasViewTypeName
,Linkable
,com.coremedia.blueprint.common.datevalidation.ValidityPeriod
Serves arbitrary download data of mime type *.*.
Represents document type CMDownload
.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Name of the document property 'data'.static final String
Name of the document property 'filename'.static final String
Name of the ContentType
'CMDownload'.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.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 TypeMethodDescriptionMap<String,
? extends com.coremedia.cae.aspect.Aspect<? extends CMDownload>> Deprecated.since 1907.1; Implement optional features as extensions.List<? extends com.coremedia.cae.aspect.Aspect<? extends CMDownload>>
Deprecated.since 1907.1; Implement optional features as extensions.com.coremedia.cap.common.Blob
getData()
Returns the value of the document propertyDATA
.Returns the value of the document propertyFILENAME
if the feature "useCMDownloadFilename" is enabled.Collection<? extends CMDownload>
Returns theLocale
specific variants of thisCMLocalized
Returns the value of the document propertyCMLocalized.MASTER
.Map<Locale,
? extends CMDownload> Returns the variants of thisCMLocalized
indexed by theirLocale
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.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.navigation.HasViewTypeName
getViewTypeName
Methods inherited from interface com.coremedia.blueprint.common.navigation.Linkable
getLocale, getSegment
-
Field Details
-
NAME
Name of the ContentType
'CMDownload'.- See Also:
-
DATA
Name of the document property 'data'.- See Also:
-
FILENAME
Name of the document property 'filename'.- See Also:
-
-
Method Details
-
getMaster
CMDownload getMaster()Returns the value of the document propertyCMLocalized.MASTER
.- Specified by:
getMaster
in interfaceCMHasContexts
- Specified by:
getMaster
in interfaceCMLinkable
- Specified by:
getMaster
in interfaceCMLocalized
- Specified by:
getMaster
in interfaceCMTeasable
- Returns:
- a
CMDownload
object
-
getVariantsByLocale
Map<Locale,? extends CMDownload> getVariantsByLocale()Description copied from interface:CMLocalized
Returns the variants of thisCMLocalized
indexed by theirLocale
- Specified by:
getVariantsByLocale
in interfaceCMHasContexts
- Specified by:
getVariantsByLocale
in interfaceCMLinkable
- Specified by:
getVariantsByLocale
in interfaceCMLocalized
- Specified by:
getVariantsByLocale
in interfaceCMTeasable
- Returns:
- the variants of this
CMLocalized
indexed by theirLocale
-
getLocalizations
Collection<? extends CMDownload> getLocalizations()Description copied from interface:CMLocalized
Returns the
Locale
specific variants of thisCMLocalized
- 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 interfaceCMHasContexts
- Specified by:
getLocalizations
in interfaceCMLinkable
- Specified by:
getLocalizations
in interfaceCMLocalized
- Specified by:
getLocalizations
in interfaceCMTeasable
- Returns:
- the
Locale
specific variants of thisCMLocalized
-
getAspectByName
@Deprecated Map<String,? extends com.coremedia.cae.aspect.Aspect<? extends CMDownload>> 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 interfaceCMHasContexts
- Specified by:
getAspectByName
in interfaceCMLinkable
- Specified by:
getAspectByName
in interfaceCMLocalized
- Specified by:
getAspectByName
in interfaceCMObject
- Specified by:
getAspectByName
in interfaceCMTeasable
- Returns:
- a Map from aspectIDs to Aspects
-
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 interfaceCMHasContexts
- Specified by:
getAspects
in interfaceCMLinkable
- Specified by:
getAspects
in interfaceCMLocalized
- Specified by:
getAspects
in interfaceCMObject
- Specified by:
getAspects
in interfaceCMTeasable
- Returns:
- a list of Aspects
-
getData
com.coremedia.cap.common.Blob getData()Returns the value of the document propertyDATA
.- Returns:
- the value of the document property
DATA
-
getFilename
String getFilename()Returns the value of the document propertyFILENAME
if the feature "useCMDownloadFilename" is enabled. The result must not be cached, it depends on the current context.- Returns:
- the filename property if the feature is enabled
-