Package com.priint.pubserver.metadata.base

Interface Document

All Superinterfaces:
Serializable
All Known Implementing Classes:
DocumentImpl, ElementDocument, GroupDocument, ItemDocument, ManifestDocument, NoteDocument, PlaceholderDocument, SpreadDocument, W2MLDocument
public interface Document extends Serializable

Base interface for all document XML types.

Base interface for all document XML types.
Derived types are

  • Method Details

    • getVersion

      String getVersion()

      Gets the version of the application, which created this document.

      Gets the version of the application, which created this document.
      In case of priint:pdf renderer, this is the pdf renderer version, in case of InDesign, this is the version of the priint:comet Plug-Ins (rather than the InDesign version).

      Returns:
      the renderer version, which created this document

    • setVersion

      void setVersion(String version)

      Sets the version of the application, which created this document.

      Sets the version of the application, which created this document.
      See also getVersion().

      Parameters:
      version - renderer version, which created this document

    • getPluginRevision

      Integer getPluginRevision()

      Gets the revision of the application, which created this document.

      Gets the revision of the application, which created this document.
      See also getVersion().

      Returns:
      the revision of the renderer, which created this document

    • setPluginRevision

      void setPluginRevision(Integer pluginRevision)

      Sets the revision of the application, which created this document.

      Sets the revision of the application, which created this document.
      See also getVersion().

      Parameters:
      pluginRevision - the revision of the renderer, which created this document

    • getRef

      Scope getRef()

      Gets the scope of the document, which is covered by this XML document.

      Gets the scope of the document, which is covered by this XML document.
      Scope describes the region of the document, which is covered by a XML document. This could be the entire document (Scope.DOCUMENT) or a single frame (Scope.ELEMENT) or any other of the values defined by this enumeration.

      Returns:
      scope of the document, which is covered by this XML document

    • setRef

      void setRef(Scope ref)

      Sets the scope of the document, which is covered by this XML document.

      Sets the scope of the document, which is covered by this XML document.
      See also getRef()

      Parameters:
      ref - scope of the document, which is covered by this XML document

    • getDocumentId

      String getDocumentId()

      Gets the document Id of this document.

      Gets the document Id of this document.
      There is no formal requirement for the Id of a document, however it should be possible to identify this document using this Id e.g. in a publication or document management system.

      Returns:
      Id of this document

    • setDocumentId

      void setDocumentId(String documentId)

      Sets the document Id of this document.

      Sets the document Id of this document.
      There is no formal requirement for the Id of a document, however it should be possible to identify this document using this Id e.g. in a publication or document management system.

      Parameters:
      documentId - Id of this document

    • getSpreadId

      Integer getSpreadId()

      Gets the spread Id of the content described in this XML document.

      Gets the spread Id of the content described in this XML document.
      If the scope (see getRef() of this XML document is a document spread, the spread Id is the index (zero based) of the spread contained in this XML document.

      Returns:
      Id (index) of the spread contained in this document

    • setSpreadId

      void setSpreadId(Integer spreadId)

      Sets the spread Id of the content described in this XML document.

      Sets the spread Id of the content described in this XML document.
      If the scope (see getRef() of this XML document is a document spread, the spread Id is the index (zero based) of the spread contained in this XML document.

      Parameters:
      spreadId - Id (index) of the spread contained in this document

    • getPageId

      Integer getPageId()

      Gets the page Id of the content described in this XML document.

      Gets the page Id of the content described in this XML document.
      If the scope (see getRef() of this XML document is a document page, the page Id is the index (zero based) of the page contained in this XML document.

      Returns:
      Id (index) of the page contained in this document

    • setPageId

      void setPageId(Integer pageId)

      Sets the page Id of the content described in this XML document.

      Sets the page Id of the content described in this XML document.
      If the scope (see getRef() of this XML document is a document page, the page Id is the index (zero based) of the page contained in this XML document.

      Parameters:
      pageId - Id (index) of the page contained in this document

    • getGroupId

      Integer getGroupId()

      Gets the group Id of the content described in this XML document.

      Gets the group Id of the content described in this XML document.
      If the scope (see getRef() of this XML document is a comet group, the group Id is the persistent UID of the comet group contained in this XML document.

      Returns:
      persistent UID of the comet group contained in this document

    • setGroupId

      void setGroupId(Integer groupId)

      Sets the group Id of the content described in this XML document.

      Sets the group Id of the content described in this XML document.
      If the scope (see getRef() of this XML document is a comet group, the group Id is the persistent UID of the comet group contained in this XML document.

      Parameters:
      groupId - persistent UID of the comet group contained in this document

    • getElementId

      Integer getElementId()

      Gets the element Id of the content described in this XML document.

      Gets the element Id of the content described in this XML document.
      If the scope (see getRef() of this XML document is an element, the element Id is the persistent UID of the element contained in this XML document.

      Returns:
      persistent UID of the element contained in this document

    • setElementId

      void setElementId(Integer elementId)

      Sets the element Id of the content described in this XML document.

      Sets the element Id of the content described in this XML document.
      If the scope (see getRef() of this XML document is an element, the element Id is the persistent UID of the element contained in this XML document.

      Parameters:
      elementId - persistent UID of the element contained in this document

    • getDocumentPath

      String getDocumentPath()

      Gets the document path / parent folder.

      Gets the document path / parent folder of the document, this XML document is based on.
      Note: the path does not contain the filename.

      Returns:
      document path / path of parent folder

    • setDocumentPath

      void setDocumentPath(String documentPath)

      Sets the document path / parent folder.

      Sets the document path / parent folder of the document, this XML document is based on.
      Note: the path does not contain the filename.

      Parameters:
      documentPath - document path / path of parent folder

    • getDocumentName

      String getDocumentName()

      Gets the document name.

      Gets the document name. This is the file system name of the document, this XML document is based on.

      Returns:
      name of the document, this XML document is based on.

    • setDocumentName

      void setDocumentName(String documentName)

      Sets the document name.

      Sets the document name. This is the file system name of the document, this XML document is based on.

      Parameters:
      documentName - name of the document, this XML document is based on.

    • getIsMissingPlugIns

      Boolean getIsMissingPlugIns()

      Gets, whether Plug-Ins where missing when generating this XML document.

      Gets, whether Plug-Ins where missing when generating this XML document.
      If this flag is true, the content of this XML file is likely to be incomplete.

      Returns:
      true, if Plug-Ins where missing, false otherwise.

    • setIsMissingPlugIns

      void setIsMissingPlugIns(Boolean isMissingPlugIns)

      Sets, whether Plug-Ins where missing when generating this XML document.

      Sets, whether Plug-Ins where missing when generating this XML document.
      If this flag is true, the content of this XML file is likely to be incomplete.

      Parameters:
      isMissingPlugIns - true, if Plug-Ins where missing, false otherwise.

    • getIsConverted

      Boolean getIsConverted()

      Gets, whether this document has been converted, when being opened.

      Gets, whether this document has been converted, when being opened.
      This flag is true, if a document has been opened e.g. with a newer InDesign version, than it was saved last.
      If this flag is true, certain properties (such as document path and name) may not be reliable.

      Returns:
      true, if the document has been converted, false otherwise.

    • setIsConverted

      void setIsConverted(Boolean isConverted)

      Sets, whether this document has been converted, when being opened.

      Sets, whether this document has been converted, when being opened.
      This flag is true, if a document has been opened e.g. with a newer InDesign version, than it was saved last.
      If this flag is true, certain properties (such as document path and name) may not be reliable.

      Parameters:
      isConverted - true, if the document has been converted, false otherwise.

    • getIsModified

      Boolean getIsModified()

      Gets the modified state of the document, this XML document is based on.

      Gets the modified state of the document, this XML document is based on.
      If this flag is true, the content of this XML document does not reflect the saved state of the document.

      Returns:
      true, if the document is in modified state, false otherwise.

    • setIsModified

      void setIsModified(Boolean isModified)

      Sets the modified state of the document, this XML document is based on.

      Sets the modified state of the document, this XML document is based on.
      If this flag is true, the content of this XML document does not reflect the saved state of the document.

      Parameters:
      isModified - true, if the document is in modified state, false otherwise.

    • getIsReadOnly

      Boolean getIsReadOnly()

      Gets, whether the document, this XML document is based on, is read only.

      Gets, whether the document, this XML document is based on, is read only.

      Returns:
      true, if the document is read only, false otherwise.

    • setIsReadOnly

      void setIsReadOnly(Boolean isReadOnly)

      Sets, whether the document, this XML document is based on, is read only.

      Sets, whether the document, this XML document is based on, is read only.

      Parameters:
      isReadOnly - true, if the document is read only, false otherwise.

    • setCreator

      void setCreator(String creator)

      Sets the document creator.

      Parameters:
      creator - the document creator

    • getCreator

      String getCreator()

      Gets the document creator.

      Returns:
      the document creator