org.apache.poi.openxml4j.opc.PackageProperties Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of poi-ooxml Show documentation
Show all versions of poi-ooxml Show documentation
Apache POI - Java API To Access Microsoft Format Files
/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==================================================================== */
package org.apache.poi.openxml4j.opc;
import java.util.Date;
import java.util.Optional;
/**
* Represents the core properties of an OPC package.
*
* @author Julien Chable
* @version 1.0
* @see org.apache.poi.openxml4j.opc.OPCPackage
*/
public interface PackageProperties {
/**
* Dublin Core Terms URI.
*/
String NAMESPACE_DCTERMS = "http://purl.org/dc/terms/";
/**
* Dublin Core namespace URI.
*/
String NAMESPACE_DC = "http://purl.org/dc/elements/1.1/";
/* Getters and setters */
/**
* Set the category of the content of this package.
* @return property value
*/
Optional getCategoryProperty();
/**
* Set the category of the content of this package.
*/
void setCategoryProperty(String category);
/**
* Set the category of the content of this package.
* @since 4.0.0
*/
void setCategoryProperty(Optional category);
/**
* Set the status of the content.
* @return property value
*/
Optional getContentStatusProperty();
/**
* Get the status of the content.
*/
void setContentStatusProperty(String contentStatus);
/**
* Get the status of the content.
* @since 4.0.0
*/
void setContentStatusProperty(Optional contentStatus);
/**
* Get the type of content represented, generally defined by a specific use
* and intended audience.
* @return property value
*/
Optional getContentTypeProperty();
/**
* Set the type of content represented, generally defined by a specific use
* and intended audience.
*/
void setContentTypeProperty(String contentType);
/**
* Set the type of content represented, generally defined by a specific use
* and intended audience.
* @since 4.0.0
*/
void setContentTypeProperty(Optional contentType);
/**
* Get the date of creation of the resource.
* @return property value
*/
Optional getCreatedProperty();
/**
* Set the date of creation of the resource.
*/
void setCreatedProperty(String created);
/**
* Set the date of creation of the resource.
*/
void setCreatedProperty(Optional created);
/**
* Get the entity primarily responsible for making the content of the
* resource.
* @return property value
*/
Optional getCreatorProperty();
/**
* Set the entity primarily responsible for making the content of the
* resource.
*/
void setCreatorProperty(String creator);
/**
* Set the entity primarily responsible for making the content of the
* resource.
* @since 4.0.0
*/
void setCreatorProperty(Optional creator);
/**
* Get the explanation of the content of the resource.
*/
Optional getDescriptionProperty();
/**
* Set the explanation of the content of the resource.
*/
void setDescriptionProperty(String description);
/**
* Set the explanation of the content of the resource.
* @since 4.0.0
*/
void setDescriptionProperty(Optional description);
/**
* Get an unambiguous reference to the resource within a given context.
* @return property value
*/
Optional getIdentifierProperty();
/**
* Set an unambiguous reference to the resource within a given context.
*/
void setIdentifierProperty(String identifier);
/**
* Set an unambiguous reference to the resource within a given context.
* @since 4.0.0
*/
void setIdentifierProperty(Optional identifier);
/**
* 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
* @return property value
*/
Optional getKeywordsProperty();
/**
* 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
*/
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
* @since 4.0.0
*/
void setKeywordsProperty(Optional keywords);
/**
* Get the language of the intellectual content of the resource.
* @return property value
*/
Optional getLanguageProperty();
/**
* Set the language of the intellectual content of the resource.
*/
void setLanguageProperty(String language);
/**
* Set the language of the intellectual content of the resource.
* @since 4.0.0
*/
void setLanguageProperty(Optional language);
/**
* Get the user who performed the last modification.
*/
Optional getLastModifiedByProperty();
/**
* Set the user who performed the last modification.
*/
void setLastModifiedByProperty(String lastModifiedBy);
/**
* Set the user who performed the last modification.
* @since 4.0.0
*/
void setLastModifiedByProperty(Optional lastModifiedBy);
/**
* Get the date and time of the last printing.
* @return property value
*/
Optional getLastPrintedProperty();
/**
* Set the date and time of the last printing.
*/
void setLastPrintedProperty(String lastPrinted);
/**
* Set the date and time of the last printing.
*/
void setLastPrintedProperty(Optional lastPrinted);
/**
* Get the date on which the resource was changed.
* @return property value
*/
Optional getModifiedProperty();
/**
* Set the date on which the resource was changed.
*/
void setModifiedProperty(String modified);
/**
* Set the date on which the resource was changed.
*/
void setModifiedProperty(Optional modified);
/**
* Get the revision number.
* @return property value
*/
Optional getRevisionProperty();
/**
* Set the revision number.
*/
void setRevisionProperty(String revision);
/**
* Set the revision number.
* @since 4.0.0
*/
void setRevisionProperty(Optional revision);
/**
* Get the topic of the content of the resource.
* @return property value
*/
Optional getSubjectProperty();
/**
* Set the topic of the content of the resource.
*/
void setSubjectProperty(String subject);
/**
* Set the topic of the content of the resource.
* @since 4.0.0
*/
void setSubjectProperty(Optional subject);
/**
* Get the name given to the resource.
* @return property value
*/
Optional getTitleProperty();
/**
* Set the name given to the resource.
*/
void setTitleProperty(String title);
/**
* Set the name given to the resource.
* @since 4.0.0
*/
void setTitleProperty(Optional title);
/**
* Get the version number.
* @return property value
*/
Optional getVersionProperty();
/**
* Set the version number.
*/
void setVersionProperty(String version);
/**
* Set the version number.
* @since 4.0.0
*/
void setVersionProperty(Optional version);
}