Package org.apache.poi.openxml4j.opc

Interface PackageProperties

  • All Known Implementing Classes:
    PackagePropertiesPart
    public interface PackageProperties
    Represents the core properties of an OPC package.
    See Also:
    OPCPackage

    • Method Detail

      • getCategoryProperty

        Optional<String> getCategoryProperty()
        Set the category of the content of this package.
        Returns:
        property value

      • setCategoryProperty

        void setCategoryProperty​(String category)
        Set the category of the content of this package.

      • setCategoryProperty

        void setCategoryProperty​(Optional<String> category)
        Set the category of the content of this package.
        Since:
        4.0.0

      • getContentStatusProperty

        Optional<String> getContentStatusProperty()
        Set the status of the content.
        Returns:
        property value

      • setContentStatusProperty

        void setContentStatusProperty​(String contentStatus)
        Get the status of the content.

      • setContentStatusProperty

        void setContentStatusProperty​(Optional<String> contentStatus)
        Get the status of the content.
        Since:
        4.0.0

      • getContentTypeProperty

        Optional<String> getContentTypeProperty()
        Get the type of content represented, generally defined by a specific use and intended audience.
        Returns:
        property value

      • setContentTypeProperty

        void setContentTypeProperty​(String contentType)
        Set the type of content represented, generally defined by a specific use and intended audience.

      • setContentTypeProperty

        void setContentTypeProperty​(Optional<String> contentType)
        Set the type of content represented, generally defined by a specific use and intended audience.
        Since:
        4.0.0

      • getCreatedProperty

        Optional<Date> getCreatedProperty()
        Get the date of creation of the resource.
        Returns:
        property value

      • setCreatedProperty

        void setCreatedProperty​(String created)
                 throws InvalidFormatException
        Set the date of creation of the resource.
        Throws:
        InvalidFormatException - only since POI 5.2.0, used to throw unchecked exception IllegalArgumentException if format was invalid

      • setCreatedProperty

        void setCreatedProperty​(Optional<Date> created)
        Set the date of creation of the resource.

      • getCreatorProperty

        Optional<String> getCreatorProperty()
        Get the entity primarily responsible for making the content of the resource.
        Returns:
        property value

      • setCreatorProperty

        void setCreatorProperty​(String creator)
        Set the entity primarily responsible for making the content of the resource.

      • setCreatorProperty

        void setCreatorProperty​(Optional<String> creator)
        Set the entity primarily responsible for making the content of the resource.
        Since:
        4.0.0

      • getDescriptionProperty

        Optional<String> getDescriptionProperty()
        Get the explanation of the content of the resource.

      • setDescriptionProperty

        void setDescriptionProperty​(String description)
        Set the explanation of the content of the resource.

      • setDescriptionProperty

        void setDescriptionProperty​(Optional<String> description)
        Set the explanation of the content of the resource.
        Since:
        4.0.0

      • getIdentifierProperty

        Optional<String> getIdentifierProperty()
        Get an unambiguous reference to the resource within a given context.
        Returns:
        property value

      • setIdentifierProperty

        void setIdentifierProperty​(String identifier)
        Set an unambiguous reference to the resource within a given context.

      • setIdentifierProperty

        void setIdentifierProperty​(Optional<String> identifier)
        Set an unambiguous reference to the resource within a given context.
        Since:
        4.0.0

      • getKeywordsProperty

        Optional<String> getKeywordsProperty()
        Get a delimited set of keywords to support searching and indexing. This is typically a list of terms that are not available elsewhere in the properties
        Returns:
        property value

      • setKeywordsProperty

        void setKeywordsProperty​(String keywords)
        Set a delimited set of keywords to support searching and indexing. This is typically a list of terms that are not available elsewhere in the properties

      • setKeywordsProperty

        void setKeywordsProperty​(Optional<String> keywords)
        Set a delimited set of keywords to support searching and indexing. This is typically a list of terms that are not available elsewhere in the properties
        Since:
        4.0.0

      • getLanguageProperty

        Optional<String> getLanguageProperty()
        Get the language of the intellectual content of the resource.
        Returns:
        property value

      • setLanguageProperty

        void setLanguageProperty​(String language)
        Set the language of the intellectual content of the resource.

      • setLanguageProperty

        void setLanguageProperty​(Optional<String> language)
        Set the language of the intellectual content of the resource.
        Since:
        4.0.0

      • getLastModifiedByProperty

        Optional<String> getLastModifiedByProperty()
        Get the user who performed the last modification.

      • setLastModifiedByProperty

        void setLastModifiedByProperty​(String lastModifiedBy)
        Set the user who performed the last modification.

      • setLastModifiedByProperty

        void setLastModifiedByProperty​(Optional<String> lastModifiedBy)
        Set the user who performed the last modification.
        Since:
        4.0.0

      • getLastPrintedProperty

        Optional<Date> getLastPrintedProperty()
        Get the date and time of the last printing.
        Returns:
        property value

      • setLastPrintedProperty

        void setLastPrintedProperty​(String lastPrinted)
                     throws InvalidFormatException
        Set the date and time of the last printing.
        Throws:
        InvalidFormatException - only since POI 5.2.0, used to throw unchecked exception IllegalArgumentException if format was invalid

      • setLastPrintedProperty

        void setLastPrintedProperty​(Optional<Date> lastPrinted)
        Set the date and time of the last printing.

      • getModifiedProperty

        Optional<Date> getModifiedProperty()
        Get the date on which the resource was changed.
        Returns:
        property value

      • setModifiedProperty

        void setModifiedProperty​(String modified)
                  throws InvalidFormatException
        Set the date on which the resource was changed.
        Throws:
        InvalidFormatException - only since POI 5.2.0, used to throw unchecked exception IllegalArgumentException if format was invalid

      • setModifiedProperty

        void setModifiedProperty​(Optional<Date> modified)
        Set the date on which the resource was changed.

      • getRevisionProperty

        Optional<String> getRevisionProperty()
        Get the revision number.
        Returns:
        property value

      • setRevisionProperty

        void setRevisionProperty​(String revision)
        Set the revision number.

      • setRevisionProperty

        void setRevisionProperty​(Optional<String> revision)
        Set the revision number.
        Since:
        4.0.0

      • getSubjectProperty

        Optional<String> getSubjectProperty()
        Get the topic of the content of the resource.
        Returns:
        property value

      • setSubjectProperty

        void setSubjectProperty​(String subject)
        Set the topic of the content of the resource.

      • setSubjectProperty

        void setSubjectProperty​(Optional<String> subject)
        Set the topic of the content of the resource.
        Since:
        4.0.0

      • getTitleProperty

        Optional<String> getTitleProperty()
        Get the name given to the resource.
        Returns:
        property value

      • setTitleProperty

        void setTitleProperty​(String title)
        Set the name given to the resource.

      • setTitleProperty

        void setTitleProperty​(Optional<String> title)
        Set the name given to the resource.
        Since:
        4.0.0

      • getVersionProperty

        Optional<String> getVersionProperty()
        Get the version number.
        Returns:
        property value

      • setVersionProperty

        void setVersionProperty​(String version)
        Set the version number.

      • setVersionProperty

        void setVersionProperty​(Optional<String> version)
        Set the version number.
        Since:
        4.0.0