Interface I_CmsEditableData

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getContextId()
      Gets the collector context id.
      java.lang.String getEditId()
      Returns the edit id.
      java.lang.String getElementId()
      Gets the element id.
      java.lang.String getElementLanguage()
      Returns the element language.
      java.lang.String getElementName()
      Returns the element name.
      org.opencms.gwt.shared.I_CmsEditableDataExtensions getExtensions()
      Gets the extended attributes.
      java.lang.String getNewLink()
      Returns the new link url.
      java.lang.String getNewTitle()
      Returns the new link url.
      java.lang.String getNoEditReason()
      Returns the no edit reason.
      java.lang.String getPostCreateHandler()
      Gets the (fully qualified) name of the post-create handler class to use.
      java.lang.String getSitePath()
      Returns the site path.
      org.opencms.util.CmsUUID getStructureId()
      Returns the structure id.
      boolean hasEditHandler()
      Returns whether an edit handler is available for the resource type.
      boolean hasResource()
      Returns true if there is an actual resource behind the editable element.
      boolean isUnreleasedOrExpired()
      Returns if the given resource is unreleased or expired.
      void setSitePath​(java.lang.String sitePath)
      Sets the site path.
    • Method Detail

      • getContextId

        java.lang.String getContextId()
        Gets the collector context id.

        Returns:
        the collector context id
      • getEditId

        java.lang.String getEditId()
        Returns the edit id.

        Returns:
        the edit id
      • getElementId

        java.lang.String getElementId()
        Gets the element id.

        Returns:
        the element id
      • getElementLanguage

        java.lang.String getElementLanguage()
        Returns the element language.

        Returns:
        the element language
      • getElementName

        java.lang.String getElementName()
        Returns the element name.

        Returns:
        the element name
      • getExtensions

        org.opencms.gwt.shared.I_CmsEditableDataExtensions getExtensions()
        Gets the extended attributes.
        Returns:
        the extended attributes
      • getNewLink

        java.lang.String getNewLink()
        Returns the new link url.

        Returns:
        the new link url
      • getNewTitle

        java.lang.String getNewTitle()
        Returns the new link url.

        Returns:
        the new link url
      • getNoEditReason

        java.lang.String getNoEditReason()
        Returns the no edit reason.

        Returns:
        the no edit reason
      • getPostCreateHandler

        java.lang.String getPostCreateHandler()
        Gets the (fully qualified) name of the post-create handler class to use.

        Returns:
        the post-create handler class name
      • getSitePath

        java.lang.String getSitePath()
        Returns the site path.

        Returns:
        the site path
      • getStructureId

        org.opencms.util.CmsUUID getStructureId()
        Returns the structure id.

        Returns:
        the structure id
      • hasEditHandler

        boolean hasEditHandler()
        Returns whether an edit handler is available for the resource type.

        Returns:
        true if an edit handler is available for the resource type
      • hasResource

        boolean hasResource()
        Returns true if there is an actual resource behind the editable element.

        Returns:
        true if the editable element represents an actual resource
      • isUnreleasedOrExpired

        boolean isUnreleasedOrExpired()
        Returns if the given resource is unreleased or expired.

        Returns:
        true if the given resource is unreleased or expired
      • setSitePath

        void setSitePath​(java.lang.String sitePath)
        Sets the site path.

        Parameters:
        sitePath - the site path