Top Description Fields Constructors Methods
org.apache.xmpbox.schema

public Class XMPRightsManagementSchema

extends XMPSchema
Class Inheritance
Annotations
@StructuredType
preferedPrefix:xmpRights
namespace:http://ns.adobe.com/xap/1.0/rights/
Imports
java.util.List, org.apache.xmpbox.XMPMetadata, org.apache.xmpbox.type.ArrayProperty, .BadFieldValueException, .BooleanType, .Cardinality, .PropertyType, .StructuredType, .TextType, .Types, .URLType
Representation of XMP Rights Management Schema
Author
a183132

Field Summary

Modifier and TypeField and Description
public static final String
CERTIFICATE

public static final String
MARKED

public static final String
OWNER

public static final String
USAGETERMS

public static final String
WEBSTATEMENT

Constructor Summary

AccessConstructor and Description
public
XMPRightsManagementSchema(XMPMetadata
The metadata to attach this schema
metadata)

Constructor of XMPRightsManagement Schema with preferred prefix

public
XMPRightsManagementSchema(XMPMetadata
The metadata to attach this schema
metadata, String
The prefix to assign
ownPrefix)

Constructor of XMPRightsManagement schema with specified prefix

Method Summary

Modifier and TypeMethod and Description
public void
addOwner(String
value to add
value)

Add a legal owner for the described resource.

public void
addUsageTerms(String
concerned language
lang, String
value to set
value)

Add an usageTerms value

public String

Returns:

certificate URL value
getCertificate()

Return the Certificate URL as String.

public TextType

Returns:

certificate url property
getCertificateProperty()

Return the Certificate URL as TextType.

public Boolean

Returns:

marked value
getMarked()

Get Marked value

public BooleanType

Returns:

Marked property
getMarkedProperty()

Get Marked property

public List<String>

Returns:

list of defined owners
getOwners()

Return a String list of owner(s)

public ArrayProperty

Returns:

owners property
getOwnersProperty()

Return the Bag of owner(s)

public String

Returns:

value of specified language or null if it doesn't exist.
getUsageTerms(String
concerned language
lang)

Return a language value for the UsageTerms property

public String

Returns:

The terms for this resource or null if it doesn't exist.
getUsageTerms()

Get the default usage terms for the document.

public List<String>

Returns:

list of languages defined for the UsageTerms property or null if it doesn't exist.
getUsageTermsLanguages()

Return a list of languages defined in the UsageTerms property

public ArrayProperty

Returns:

usageterms property
getUsageTermsProperty()

Return the Lang alt UsageTerms

public String

Returns:

webStatement URL value
getWebStatement()

Return the WebStatement URL as String.

public TextType

Returns:

Webstatement URL property
getWebStatementProperty()

Return the WebStatement URL as TextType.

public void
removeOwner(String value)

public void
setCertificate(String
certificate url value to set
url)

Set the Certificate URL.

public void
setCertificateProperty(URLType
certificate url property to set
url)

Set the Certificate URL.

public void
setMarked(Boolean
value to add
marked)

Set Marked value

public void
setMarkedProperty(BooleanType
Marked property to set
marked)

Set Marked property

public void
setUsageTerms(String
The resource usage terms.
terms)

Set the default usage terms for this resource.

public void
setWebStatement(String
WebStatemen url value to set
url)

Set the WebStatement url

public void
setWebStatementProperty(URLType
WebStatemen url property to set
url)

Set the WebStatement url

Inherited from org.apache.xmpbox.schema.XMPSchema:
addBagValueaddBagValueAsSimpleaddQualifiedBagValueaddSequenceDateValueAsSimpleaddUnqualifiedSequenceDateValueaddUnqualifiedSequenceValueaddUnqualifiedSequenceValuegetAboutAttributegetAboutValuegetAbstractPropertygetBooleanPropertygetBooleanPropertyValuegetBooleanPropertyValueAsSimplegetDatePropertygetDatePropertyValuegetDatePropertyValueAsSimplegetIntegerPropertygetIntegerPropertyValuegetIntegerPropertyValueAsSimplegetUnqualifiedArrayListgetUnqualifiedBagValueListgetUnqualifiedLanguagePropertyLanguagesValuegetUnqualifiedLanguagePropertyValuegetUnqualifiedSequenceDateValueListgetUnqualifiedSequenceValueListgetUnqualifiedTextPropertygetUnqualifiedTextPropertyValueinstanciateSimplemergeremoveUnqualifiedArrayValueremoveUnqualifiedBagValueremoveUnqualifiedSequenceDateValueremoveUnqualifiedSequenceValueremoveUnqualifiedSequenceValuereorganizeAltOrdersetAboutsetAboutAsSimplesetBooleanPropertysetBooleanPropertyValuesetBooleanPropertyValueAsSimplesetDatePropertysetDatePropertyValuesetDatePropertyValueAsSimplesetIntegerPropertysetIntegerPropertyValuesetIntegerPropertyValueAsSimplesetTextPropertysetTextPropertyValuesetTextPropertyValueAsSimplesetUnqualifiedLanguagePropertyValue

Field Detail

CERTIFICATEback to summary
public static final String CERTIFICATE
Annotations
@PropertyType
type:URL
card:Simple
MARKEDback to summary
public static final String MARKED
Annotations
@PropertyType
type:Boolean
card:Simple
OWNERback to summary
public static final String OWNER
Annotations
@PropertyType
type:ProperName
card:Bag
USAGETERMSback to summary
public static final String USAGETERMS
Annotations
@PropertyType
type:LangAlt
card:Simple
WEBSTATEMENTback to summary
public static final String WEBSTATEMENT
Annotations
@PropertyType
type:URL
card:Simple

Constructor Detail

XMPRightsManagementSchemaback to summary
public XMPRightsManagementSchema(XMPMetadata metadata)

Constructor of XMPRightsManagement Schema with preferred prefix

Parameters
metadata:XMPMetadata

The metadata to attach this schema

XMPRightsManagementSchemaback to summary
public XMPRightsManagementSchema(XMPMetadata metadata, String ownPrefix)

Constructor of XMPRightsManagement schema with specified prefix

Parameters
metadata:XMPMetadata

The metadata to attach this schema

ownPrefix:String

The prefix to assign

Method Detail

addOwnerback to summary
public void addOwner(String value)

Add a legal owner for the described resource.

Parameters
value:String

value to add

addUsageTermsback to summary
public void addUsageTerms(String lang, String value)

Add an usageTerms value

Parameters
lang:String

concerned language

value:String

value to set

getCertificateback to summary
public String getCertificate()

Return the Certificate URL as String.

Returns:String

certificate URL value

getCertificatePropertyback to summary
public TextType getCertificateProperty()

Return the Certificate URL as TextType.

Returns:TextType

certificate url property

getMarkedback to summary
public Boolean getMarked()

Get Marked value

Returns:Boolean

marked value

getMarkedPropertyback to summary
public BooleanType getMarkedProperty()

Get Marked property

Returns:BooleanType

Marked property

getOwnersback to summary
public List<String> getOwners()

Return a String list of owner(s)

Returns:List<String>

list of defined owners

getOwnersPropertyback to summary
public ArrayProperty getOwnersProperty()

Return the Bag of owner(s)

Returns:ArrayProperty

owners property

getUsageTermsback to summary
public String getUsageTerms(String lang) throws BadFieldValueException

Return a language value for the UsageTerms property

Parameters
lang:String

concerned language

Returns:String

value of specified language or null if it doesn't exist.

Exceptions
BadFieldValueException:
If the UsageTerms property is not a multi-lingual property.
getUsageTermsback to summary
public String getUsageTerms() throws BadFieldValueException

Get the default usage terms for the document.

Returns:String

The terms for this resource or null if it doesn't exist.

Exceptions
BadFieldValueException:
If the UsageTerms property is not a multi-lingual property.
getUsageTermsLanguagesback to summary
public List<String> getUsageTermsLanguages() throws BadFieldValueException

Return a list of languages defined in the UsageTerms property

Returns:List<String>

list of languages defined for the UsageTerms property or null if it doesn't exist.

Exceptions
BadFieldValueException:
If the UsageTerms property is not a multi-lingual property.
getUsageTermsPropertyback to summary
public ArrayProperty getUsageTermsProperty()

Return the Lang alt UsageTerms

Returns:ArrayProperty

usageterms property

getWebStatementback to summary
public String getWebStatement()

Return the WebStatement URL as String.

Returns:String

webStatement URL value

getWebStatementPropertyback to summary
public TextType getWebStatementProperty()

Return the WebStatement URL as TextType.

Returns:TextType

Webstatement URL property

removeOwnerback to summary
public void removeOwner(String value)
setCertificateback to summary
public void setCertificate(String url)

Set the Certificate URL.

Parameters
url:String

certificate url value to set

setCertificatePropertyback to summary
public void setCertificateProperty(URLType url)

Set the Certificate URL.

Parameters
url:URLType

certificate url property to set

setMarkedback to summary
public void setMarked(Boolean marked)

Set Marked value

Parameters
marked:Boolean

value to add

setMarkedPropertyback to summary
public void setMarkedProperty(BooleanType marked)

Set Marked property

Parameters
marked:BooleanType

Marked property to set

setUsageTermsback to summary
public void setUsageTerms(String terms)

Set the default usage terms for this resource.

Parameters
terms:String

The resource usage terms.

setWebStatementback to summary
public void setWebStatement(String url)

Set the WebStatement url

Parameters
url:String

WebStatemen url value to set

setWebStatementPropertyback to summary
public void setWebStatementProperty(URLType url)

Set the WebStatement url

Parameters
url:URLType

WebStatemen url property to set