Package com.saperion.intf

Interface SaDocInfo

  • All Superinterfaces:
    java.io.Serializable
    All Known Implementing Classes:
    SaDocInfoImpl
    public interface SaDocInfo
extends java.io.Serializable
    Holds information about a document like the document's structure and variables read from the archive.

    • Method Detail

      • getVariableData

        java.util.Properties getVariableData()
        Returns variables of the document. Use SaDocInfo.ElementInfo.getVariableData() to get variables contained in a specific element.
        Returns:
        Document variable data

      • getElementInfo

        java.util.List<SaDocInfo.ElementInfo> getElementInfo()
        Returns a list of the structure-elements of this document.
        Returns:
        Element information

      • getElementInfoMap

        java.util.Map<java.lang.Integer,​SaDocInfo.ElementInfo> getElementInfoMap()
        Returns the structure-elements as a map with the corresponding element number as key.
        Returns:
        the element information as a map.

      • getElementInfo

        SaDocInfo.ElementInfo getElementInfo​(int elementNumber)
        Returns the element info of the element with the specified number, if existing. Null is returned if no element-info is existing for the given element number.
        Parameters:
        elementNumber - The element number to get information for
        Returns:
        the document info for the given element number, if existing - null otherwise.

      • getElementCount

        int getElementCount()
        Returns:
        Element count

      • getCreateUser

        int getCreateUser()
        Returns:
        Document create user

      • hasAnnotations

        boolean hasAnnotations()
        Returns:
        true if the document contains annotations

      • getHdoc

        java.lang.String getHdoc()
        Returns:
        hDoc of the revision represented by this SaDocInfo instance