Interface Generator

  • All Superinterfaces:
    java.io.Serializable
    All Known Implementing Classes:
    GeneratorImpl

    public interface Generator
    extends java.io.Serializable

    Interface for the manifest-generator XML type

    Interface for the manifest-generator XML type used in the Manifest document type.
    Generator should provide information about how and when this meta data archive has been generated. There is no normative specification for particular attribute values. The information provided should be as short as possible and as descriptive as required.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getCopiedFromId()
      Gets the original document Id of this meta data archive.
      java.lang.String getCopiedFromPath()
      Gets the original document path of this meta data archive.
      java.util.Date getDate()
      Gets the creation date of this meta data archive.
      java.lang.String getName()
      Gets the name of the generator.
      java.lang.String getPlatform()
      Gets the name of the platform.
      void setCopiedFromId​(java.lang.String copiedFromId)
      Sets the original document Id of this meta data archive.
      void setCopiedFromPath​(java.lang.String copiedFromPath)
      Sets the original document path of this meta data archive.
      void setDate​(java.util.Date date)
      Sets the creation date of this meta data archive.
      void setName​(java.lang.String name)
      Sets the name of the generator.
      void setPlatform​(java.lang.String platform)
      Sets the name of the platform.
    • Method Detail

      • getName

        java.lang.String getName()

        Gets the name of the generator.

        Gets the name of the generator of this meta data archive, e.g. priint:PDF Renderer

        Returns:
        the name of the generator
      • setName

        void setName​(java.lang.String name)

        Sets the name of the generator.

        Sets the name of the generator of this meta data archive.

        Parameters:
        name - name of the generator
      • getPlatform

        java.lang.String getPlatform()

        Gets the name of the platform.

        Gets the name of the platform, this meta data archive was generated on, e.g. MacOS.

        Returns:
        name of the platform
      • setPlatform

        void setPlatform​(java.lang.String platform)

        Sets the name of the platform.

        Sets the name of the platform, this meta data archive was generated on

        Parameters:
        platform - name of the platform
      • getDate

        java.util.Date getDate()

        Gets the creation date of this meta data archive.

        Gets the date, this meta data archive was created.

        Returns:
        creation date of this meta data archive
      • setDate

        void setDate​(java.util.Date date)

        Sets the creation date of this meta data archive.

        Sets the date, this meta data archive was created.

        Parameters:
        date - creation date of this meta data archive
      • getCopiedFromId

        java.lang.String getCopiedFromId()

        Gets the original document Id of this meta data archive.

        Gets the original document Id of this meta data archive.
        If the meta data archive has been copied (e.g. when duplicating a document), this is the Id of the document, this meta data archive was originally associated to.

        Returns:
        Id of the original document
      • setCopiedFromId

        void setCopiedFromId​(java.lang.String copiedFromId)

        Sets the original document Id of this meta data archive.

        Sets the original document Id of this meta data archive.
        If the meta data archive has been copied (e.g. when duplicating a document), this should be set to the Id of the document, this meta data archive was originally associated to.

        Parameters:
        copiedFromId - Id of the original document
      • getCopiedFromPath

        java.lang.String getCopiedFromPath()

        Gets the original document path of this meta data archive.

        Gets the original document path of this meta data archive.
        If the meta data archive has been copied (e.g. when duplicating a document), this is the path of the document, this meta data archive was originally associated to.

        Returns:
        path of the original document
      • setCopiedFromPath

        void setCopiedFromPath​(java.lang.String copiedFromPath)

        Sets the original document path of this meta data archive.

        Sets the original document path of this meta data archive.
        If the meta data archive has been copied (e.g. when duplicating a document), this should be set to the path of the document, this meta data archive was originally associated to.

        Parameters:
        copiedFromPath - path of the original document