Package com.tridion.meta

Interface PageMeta

All Superinterfaces:
Item
public interface PageMeta extends Item
This is the public interface for all Page metadata. It extends the Item interface and adds access to other properties, namely the Path, Template id and URL path.

  • Method Details

    • getSchemaId

      int getSchemaId()
      Returns the id of the Schema that is used to create this Page.
      Returns:
      the id of the schema for this Page.

    • getPath

      String getPath()
      Retrieves the path to the page on disk.
      Returns:
      the path to the page

    • setPath

      void setPath(String path)
      Sets the path to the page on disk.
      Parameters:
      path - the path to the page

    • getTemplateId

      int getTemplateId()
      Retrieves the page's template ID.
      Returns:
      the page's template ID

    • setTemplateId

      void setTemplateId(int templateId)
      Set the page's template ID.
      Parameters:
      templateId - the page's template ID

    • getURLPath

      String getURLPath()
      Retrieves the URL path to the page (relative to the webroot).
      Returns:
      the URL path to the page

    • getComponentPresentationMetas

      List<ComponentPresentationMeta> getComponentPresentationMetas() throws com.tridion.broker.StorageException
      Returns an unmodifiable list containing a ComponentPresentationMeta object for each component presentations that is present on the page that is identified by this PageMeta. The ComponentPresentationMeta objects in the list are in the order in which the component presentations are on the page. When using this method, you should be aware that not all implementation classes necessarily implement this method. Look at the documentation for the specific implementation class to see whether the method is implemented. Also be aware that using this method, might cause the PageMeta implementation class to go out to the broker storage layer to retrieve information about the component presentations on the page. Note that this method returns metadata for both dynamic component presentations as well as component presentations that are published embedded on the page.
      Returns:
      a list with a ComponentPresentationMeta for each component presentation that's present on this page
      Throws:
      com.tridion.broker.StorageException - when there is a problem loading the component presentation meta information for this page meta.

    • getCustomMeta

      CustomMeta getCustomMeta()
      Returns the CustomMetaData for this Page, if there is any. If there is none, null is returned.
      Returns:
      the CustomMetaData for this Page as a CustomMeta object, or null if there is none.

    • getStructureGroup

      String getStructureGroup()
      Returns structure group.
      Returns:
      Structure group for the page.