Package com.coremedia.blueprint.common.contentbeans

Interface AbstractPage

All Superinterfaces:
com.coremedia.blueprint.common.datevalidation.ValidityPeriod
All Known Subinterfaces:
Page
public interface AbstractPage extends com.coremedia.blueprint.common.datevalidation.ValidityPeriod
An abstraction from full Pages and Page Fragments.

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,? extends com.coremedia.cae.aspect.Aspect>
    getAspectByName()
    Deprecated.
    since 1907.1; Implement optional features as extensions.
    Object
    getContent()
    Returns the main content object rendered on this page
    String
    getContentId()
    Returns an id of the main content rendered on this page, e.g.
    String
    getContentType()
    Returns an optional type or classifier name of the main content rendered on this page, e.g.
    String
    getDescription()
    Deprecated.
    use instead
    String
    getDirection()
    Returns a String "ltr" or "rtl" depending to the Locale for this page
    String
    getKeywords()
    Returns the keywords for this page
    Locale
    getLocale()
    Returns the Locale for this abstract page.
    Navigation
    getNavigation()
    Returns the navigation denoted by the uri of the request for this response which is not necessarily a content bean.
    PageGrid
    getPageGrid()
    Returns a PageGrid
    String
    getTitle()
    Returns the title for this page
    boolean
    isDetailView()
    A page is considered to be a detail view if the main contend rendered on the page is not a navigation node.
    boolean
    isDeveloperMode()
    Returns true, if the CAE that rendered this response runs in development mode.

    Methods inherited from interface com.coremedia.blueprint.common.datevalidation.ValidityPeriod

    getValidFrom, getValidTo

  • Method Details

    • getNavigation

      Navigation getNavigation()
      Returns the navigation denoted by the uri of the request for this response which is not necessarily a content bean.
      Returns:
      The navigation instance of this page.

    • getContent

      Object getContent()
      Returns the main content object rendered on this page

    • isDeveloperMode

      boolean isDeveloperMode()
      Returns true, if the CAE that rendered this response runs in development mode.

    • getPageGrid

      PageGrid getPageGrid()
      Returns a PageGrid

    • getLocale

      Locale getLocale()
      Returns the Locale for this abstract page.

    • getDirection

      String getDirection()
      Returns a String "ltr" or "rtl" depending to the Locale for this page

    • getTitle

      String getTitle()
      Returns the title for this page

    • getKeywords

      String getKeywords()
      Returns the keywords for this page

    • getDescription

      @Deprecated String getDescription()
      Deprecated.
      use instead
      Returns the description for this page

    • isDetailView

      boolean isDetailView()
      A page is considered to be a detail view if the main contend rendered on the page is not a navigation node.
      Returns:
      true if if the getContent() main content} of this page is not Navigation instance.

    • getAspectByName

      @Deprecated Map<String,? extends com.coremedia.cae.aspect.Aspect> getAspectByName()
      Deprecated.
      since 1907.1; Implement optional features as extensions.
      Returns a Map from aspectIDs to Aspects. AspectIDs consists of an aspect name with a prefix which identifies the plugin provider.
      Returns:
      a Map from aspectIDs to Aspects

    • getContentId

      String getContentId()
      Returns an id of the main content rendered on this page, e.g. for analytics purposes. May be null.

    • getContentType

      String getContentType()
      Returns an optional type or classifier name of the main content rendered on this page, e.g. for analytics purposes. May be null.