org.apache.jempbox.xmp
Class XMPSchemaRightsManagement

java.lang.Object
  extended by org.apache.jempbox.xmp.XMPSchema
      extended by org.apache.jempbox.xmp.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 String NAMESPACE
          The namespace for this schema.
 
Fields inherited from class org.apache.jempbox.xmp.XMPSchema
NS_NAMESPACE, prefix, schema
 
Constructor Summary
XMPSchemaRightsManagement(Element element, String prefix)
          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.
 String getCopyright()
          Get the copyright information.
 Boolean getMarked()
          Get the flag that indicates if this is a marked resource..
 List<String> 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<String> 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 setCopyright(String copyright)
          Set the copyright information.
 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.apache.jempbox.xmp.XMPSchema
addBagValue, addSequenceDateValue, addSequenceValue, addSequenceValue, getAbout, getBagList, getBooleanProperty, getDateProperty, getElement, getEventSequenceList, getIntegerProperty, getLanguageProperty, getLanguagePropertyLanguages, getSequenceDateList, getSequenceList, getTextProperty, getThumbnailProperty, merge, removeBagValue, removeSequenceDateValue, removeSequenceValue, removeSequenceValue, setAbout, setBooleanProperty, setDateProperty, setIntegerProperty, setLanguageProperty, setTextProperty, setThumbnailProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NAMESPACE

public static final String NAMESPACE
The namespace for this schema.

See Also:
Constant Field Values
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

setCertificateURL

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

Parameters:
certificate - The URL to the rights cert.

getCertificateURL

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

Returns:
The rights management certificate URL.

setMarked

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

Parameters:
marked - The marked value.

getMarked

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

Returns:
The value of the marked flag.

removeOwner

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

Parameters:
owner - The owner to remove.

addOwner

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

Parameters:
owner - A new legal owner to this resource.

getOwners

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

Returns:
The list of owners.

setUsageTerms

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

Parameters:
terms - The resource usage terms.

getUsageTerms

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

Returns:
The terms for this resource.

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.

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<String> getUsageTermsLanguages()
Get a list of all languages that a usage term exists for.

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

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.

getWebStatement

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

Returns:
The usage rights URL.

setCopyright

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

Parameters:
copyright - The copyright information.

getCopyright

public String getCopyright()
Get the copyright information.

Returns:
The copyright information.


Copyright © 2002-2012 Apache Software Foundation. All Rights Reserved.