org.apache.jempbox.xmp

Class XMPSchemaRightsManagement

public class XMPSchemaRightsManagement extends XMPSchema

Define XMP properties that are related to rights management.

Version: $Revision: 1.6 $

Author: Ben Litchfield

Field Summary
static StringNAMESPACE
The namespace for this schema.
Constructor Summary
XMPSchemaRightsManagement(XMPMetadata parent)
Construct a new blank PDF schema.
XMPSchemaRightsManagement(Element element, String prefix)
Constructor from existing XML element.
Method Summary
voidaddOwner(String owner)
Add an owner to the list.
StringgetCertificateURL()
Get the URL of the rights managment certificate.
StringgetCopyright()
Get the copyright information.
BooleangetMarked()
Get the flag that indicates if this is a marked resource..
ListgetOwners()
Get the complete list of legal owners.
StringgetUsageTerms()
Get the default usage terms for the document.
StringgetUsageTerms(String language)
Get the usage terms in a specific language.
ListgetUsageTermsLanguages()
Get a list of all languages that a usage term exists for.
StringgetWebStatement()
Get the URL that describes the terms of this resource.
voidremoveOwner(String owner)
Remove an owner from the list.
voidsetCertificateURL(String certificate)
The online rights management certificate.
voidsetCopyright(String copyright)
Set the copyright information.
voidsetDescription(String language, String terms)
Set the usage terms of this resource in a specific language.
voidsetMarked(Boolean marked)
Flag indicating if this is a rights managed resource.
voidsetUsageTerms(String terms)
Set the default usage terms for this resource.
voidsetWebStatement(String webStatement)
Set the external link that describes the owners/rights of this resource.

Field Detail

NAMESPACE

public static final String NAMESPACE
The namespace for this schema.

Constructor Detail

XMPSchemaRightsManagement

public XMPSchemaRightsManagement(XMPMetadata parent)
Construct a new blank PDF schema.

Parameters: parent The parent metadata schema that this will be part of.

XMPSchemaRightsManagement

public XMPSchemaRightsManagement(Element element, String prefix)
Constructor from existing XML element.

Parameters: element The existing element. prefix The schema prefix.

Method Detail

addOwner

public void addOwner(String owner)
Add an owner to the list.

Parameters: owner A new legal owner to this resource.

getCertificateURL

public String getCertificateURL()
Get the URL of the rights managment certificate.

Returns: The rights management certificate URL.

getCopyright

public String getCopyright()
Get the copyright information.

Returns: The copyright information.

getMarked

public Boolean getMarked()
Get the flag that indicates if this is a marked resource..

Returns: The value of the marked flag.

getOwners

public List getOwners()
Get the complete list of legal owners.

Returns: The list of owners.

getUsageTerms

public String getUsageTerms()
Get the default usage terms for the document.

Returns: The terms for this resource.

getUsageTerms

public String getUsageTerms(String language)
Get the usage terms in a specific language.

Parameters: language The language code to get the description for.

Returns: The usage terms in the specified language or null if it does not exist.

getUsageTermsLanguages

public List getUsageTermsLanguages()
Get a list of all languages that a usage term exists for.

Returns: A non-null list of languages, potentially an empty list.

getWebStatement

public String getWebStatement()
Get the URL that describes the terms of this resource.

Returns: The usage rights URL.

removeOwner

public void removeOwner(String owner)
Remove an owner from the list.

Parameters: owner The owner to remove.

setCertificateURL

public void setCertificateURL(String certificate)
The online rights management certificate.

Parameters: certificate The URL to the rights cert.

setCopyright

public void setCopyright(String copyright)
Set the copyright information.

Parameters: copyright The copyright information.

setDescription

public void setDescription(String language, String terms)
Set the usage terms of this resource in a specific language.

Parameters: language The language code. terms The terms of this resource.

setMarked

public void setMarked(Boolean marked)
Flag indicating if this is a rights managed resource.

Parameters: marked The marked value.

setUsageTerms

public void setUsageTerms(String terms)
Set the default usage terms for this resource.

Parameters: terms The resource usage terms.

setWebStatement

public void setWebStatement(String webStatement)
Set the external link that describes the owners/rights of this resource.

Parameters: webStatement The URL to a terms site.