Package com.tridion.dcp

Interface ComponentPresentation

All Known Subinterfaces:
ASCXComponentPresentation, ASPComponentPresentation, JSPComponentPresentation, ScriptedComponentPresentation, XMLComponentPresentation
public interface ComponentPresentation
ComponentPresentation.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getComponentId()
    Gets this component presentation's component ID.
    int
    getComponentTemplateId()
    Gets this component presentation's template ID.
    String
    getContent()
    Gets the content of this component presentation.
    String
    getContent(boolean track)
    Gets the content of this component presentation.
    String
    getFileLocation()
    Gets this component presentation's file location or null if no file-system based.
    ComponentPresentationMeta
    getMeta()
    Gets the component presentation meta object for this component presentation.
    int
    getNamespaceId()
    Gets this component presentation's namespace ID.
    int
    getPublicationId()
    Gets this component presentation's publication ID.
    boolean
    isDynamic()
    Returns if this ComponentPresentation contains dynamic code.

  • Method Details

    • getContent

      String getContent(boolean track)
      Gets the content of this component presentation.

      Note: For JSPComponentPresentation objects, this method may not work correctly. Instead, read the file directly using the correct encoding, using getFileLocation of the interface JSPComponentPresentation.

      Parameters:
      track - Current not used.
      Returns:
      The content.
      See Also:

    • getContent

      String getContent()
      Gets the content of this component presentation.

      Note: For JSPComponentPresentation objects, this method may not work correctly. Instead, read the file directly using the correct encoding, using getFileLocation of the interface JSPComponentPresentation.

      Returns:
      The content.
      See Also:

    • getMeta

      ComponentPresentationMeta getMeta()
      Gets the component presentation meta object for this component presentation.
      Returns:
      The corresponding component presentation meta object.

    • getNamespaceId

      int getNamespaceId()
      Gets this component presentation's namespace ID.
      Returns:
      The namespace ID.

    • getPublicationId

      int getPublicationId()
      Gets this component presentation's publication ID.
      Returns:
      The publication ID.

    • getComponentId

      int getComponentId()
      Gets this component presentation's component ID.
      Returns:
      The component ID.

    • getComponentTemplateId

      int getComponentTemplateId()
      Gets this component presentation's template ID.
      Returns:
      The template ID.

    • getFileLocation

      String getFileLocation()
      Gets this component presentation's file location or null if no file-system based.
      Returns:
      The file location.

    • isDynamic

      boolean isDynamic()
      Returns if this ComponentPresentation contains dynamic code.
      Returns:
      True if it contains dynamic code, False if not