org.jempbox.xmp

Class XMPSchemaRightsManagement


public class XMPSchemaRightsManagement
extends XMPSchema

Define XMP properties that are related to rights management.
Version:
$Revision: 1.1 $
Author:
Ben Litchfield (ben@benlitchfield.com)

Field Summary

static String
NAMESPACE
The namespace for this schema.

Fields inherited from class org.jempbox.xmp.XMPSchema

schema

Constructor Summary

XMPSchemaRightsManagement(Element element)
Constructor from existing XML element.
XMPSchemaRightsManagement(XMPMetadata parent)
Construct a new blank PDF schema.

Method Summary

void
addOwner(String owner)
Add an owner to the list.
String
getCertificateURL()
Get the URL of the rights managment certificate.
Boolean
getMarked()
Get the flag that indicates if this is a mared resource..
List
getOwners()
Get the complete list of legal owners.
String
getUsageTerms()
Get the default usage terms for the document.
String
getUsageTerms(String language)
Get the usage terms in a specific language.
List
getUsageTermsLanguages()
Get a list of all languages that a usage term exists for.
String
getWebStatement()
Get the URL that describes the terms of this resource.
void
removeOwner(String owner)
Remove an owner from the list.
void
setCertificateURL(String certificate)
The online rights management certificate.
void
setDescription(String language, String terms)
Set the usage terms of this resource in a specific language.
void
setMarked(Boolean marked)
Flag indicating if this is a rights managed resource.
void
setUsageTerms(String terms)
Set the default usage terms for this resource.
void
setWebStatement(String webStatement)
Set the external link that describes the owners/rights of this resource.

Methods inherited from class org.jempbox.xmp.XMPSchema

addBagValue, addSequenceDateValue, addSequenceValue, addSequenceValue, getAbout, getBagList, getBooleanProperty, getDateProperty, getElement, getEventSequenceList, getIntegerProperty, getLanguageProperty, getLanguagePropertyLanguages, getSequenceDateList, getSequenceList, getTextProperty, getThumbnailProperty, removeBagValue, removeSequenceDateValue, removeSequenceValue, removeSequenceValue, setAbout, setBooleanProperty, setDateProperty, setIntegerProperty, setLanguageProperty, setTextProperty, setThumbnailProperty

Field Details

NAMESPACE

public static final String NAMESPACE
The namespace for this schema.

Constructor Details

XMPSchemaRightsManagement

public XMPSchemaRightsManagement(Element element)
Constructor from existing XML element.
Parameters:
element - The existing element.

XMPSchemaRightsManagement

public XMPSchemaRightsManagement(XMPMetadata parent)
Construct a new blank PDF schema.
Parameters:
parent - The parent metadata schema that this will be part of.

Method Details

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.

getMarked

public Boolean getMarked()
Get the flag that indicates if this is a mared 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.

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.