Package org.apache.xmpbox.schema
Class XMPRightsManagementSchema
- java.lang.Object
-
- org.apache.xmpbox.type.AbstractField
-
- org.apache.xmpbox.type.AbstractComplexProperty
-
- org.apache.xmpbox.type.AbstractStructuredType
-
- org.apache.xmpbox.schema.XMPSchema
-
- org.apache.xmpbox.schema.XMPRightsManagementSchema
-
public class XMPRightsManagementSchema extends XMPSchema
Representation of XMP Rights Management Schema
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CERTIFICATE
static java.lang.String
MARKED
static java.lang.String
OWNER
static java.lang.String
USAGETERMS
static java.lang.String
WEBSTATEMENT
-
Fields inherited from class org.apache.xmpbox.type.AbstractStructuredType
STRUCTURE_ARRAY_NAME
-
-
Constructor Summary
Constructors Constructor Description XMPRightsManagementSchema(XMPMetadata metadata)
Constructor of XMPRightsManagement Schema with preferred prefixXMPRightsManagementSchema(XMPMetadata metadata, java.lang.String ownPrefix)
Constructor of XMPRightsManagement schema with specified prefix
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addOwner(java.lang.String value)
Add a legal owner for the described resource.void
addUsageTerms(java.lang.String lang, java.lang.String value)
Add an usageTerms valuejava.lang.String
getCertificate()
Return the Certificate URL as String.TextType
getCertificateProperty()
Return the Certificate URL as TextType.java.lang.Boolean
getMarked()
Get Marked valueBooleanType
getMarkedProperty()
Get Marked propertyjava.util.List<java.lang.String>
getOwners()
Return a String list of owner(s)ArrayProperty
getOwnersProperty()
Return the Bag of owner(s)java.lang.String
getUsageTerms()
Get the default usage terms for the document.java.lang.String
getUsageTerms(java.lang.String lang)
Return a language value for description propertyjava.util.List<java.lang.String>
getUsageTermsLanguages()
Return a list of languages defined in description propertyArrayProperty
getUsageTermsProperty()
Return the Lang alt UsageTermsjava.lang.String
getWebStatement()
Return the WebStatement URL as String.TextType
getWebStatementProperty()
Return the WebStatement URL as TextType.void
removeOwner(java.lang.String value)
void
setCertificate(java.lang.String url)
Set the Certificate URL.void
setCertificateProperty(URLType url)
Set the Certificate URL.void
setMarked(java.lang.Boolean marked)
Set Marked valuevoid
setMarkedProperty(BooleanType marked)
Set Marked propertyvoid
setUsageTerms(java.lang.String terms)
Set the default usage terms for this resource.void
setWebStatement(java.lang.String url)
Set the WebStatement urlvoid
setWebStatementProperty(URLType url)
Set the WebStatement url-
Methods inherited from class org.apache.xmpbox.schema.XMPSchema
addBagValue, addBagValueAsSimple, addQualifiedBagValue, addSequenceDateValueAsSimple, addUnqualifiedSequenceDateValue, addUnqualifiedSequenceValue, addUnqualifiedSequenceValue, getAboutAttribute, getAboutValue, getAbstractProperty, getBooleanProperty, getBooleanPropertyValue, getBooleanPropertyValueAsSimple, getDateProperty, getDatePropertyValue, getDatePropertyValueAsSimple, getIntegerProperty, getIntegerPropertyValue, getIntegerPropertyValueAsSimple, getUnqualifiedArrayList, getUnqualifiedBagValueList, getUnqualifiedLanguagePropertyLanguagesValue, getUnqualifiedLanguagePropertyValue, getUnqualifiedSequenceDateValueList, getUnqualifiedSequenceValueList, getUnqualifiedTextProperty, getUnqualifiedTextPropertyValue, instanciateSimple, merge, removeUnqualifiedArrayValue, removeUnqualifiedBagValue, removeUnqualifiedSequenceDateValue, removeUnqualifiedSequenceValue, removeUnqualifiedSequenceValue, reorganizeAltOrder, setAbout, setAboutAsSimple, setBooleanProperty, setBooleanPropertyValue, setBooleanPropertyValueAsSimple, setDateProperty, setDatePropertyValue, setDatePropertyValueAsSimple, setIntegerProperty, setIntegerPropertyValue, setIntegerPropertyValueAsSimple, setTextProperty, setTextPropertyValue, setTextPropertyValueAsSimple, setUnqualifiedLanguagePropertyValue
-
Methods inherited from class org.apache.xmpbox.type.AbstractStructuredType
addSimpleProperty, createArrayProperty, createTextType, getDatePropertyAsCalendar, getNamespace, getPreferedPrefix, getPrefix, getPropertyValueAsString, setNamespace, setPrefix
-
Methods inherited from class org.apache.xmpbox.type.AbstractComplexProperty
addNamespace, addProperty, getAllNamespacesWithPrefix, getAllProperties, getArrayProperty, getContainer, getFirstEquivalentProperty, getNamespacePrefix, getProperty, removeProperty
-
Methods inherited from class org.apache.xmpbox.type.AbstractField
containsAttribute, getAllAttributes, getAttribute, getMetadata, getPropertyName, removeAttribute, setAttribute, setPropertyName
-
-
-
-
Field Detail
-
CERTIFICATE
public static final java.lang.String CERTIFICATE
- See Also:
- Constant Field Values
-
MARKED
public static final java.lang.String MARKED
- See Also:
- Constant Field Values
-
OWNER
public static final java.lang.String OWNER
- See Also:
- Constant Field Values
-
USAGETERMS
public static final java.lang.String USAGETERMS
- See Also:
- Constant Field Values
-
WEBSTATEMENT
public static final java.lang.String WEBSTATEMENT
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
XMPRightsManagementSchema
public XMPRightsManagementSchema(XMPMetadata metadata)
Constructor of XMPRightsManagement Schema with preferred prefix- Parameters:
metadata
- The metadata to attach this schema
-
XMPRightsManagementSchema
public XMPRightsManagementSchema(XMPMetadata metadata, java.lang.String ownPrefix)
Constructor of XMPRightsManagement schema with specified prefix- Parameters:
metadata
- The metadata to attach this schemaownPrefix
- The prefix to assign
-
-
Method Detail
-
addOwner
public void addOwner(java.lang.String value)
Add a legal owner for the described resource.- Parameters:
value
- value to add
-
removeOwner
public void removeOwner(java.lang.String value)
-
getOwnersProperty
public ArrayProperty getOwnersProperty()
Return the Bag of owner(s)- Returns:
- owners property
-
getOwners
public java.util.List<java.lang.String> getOwners()
Return a String list of owner(s)- Returns:
- list of defined owners
-
setMarked
public void setMarked(java.lang.Boolean marked)
Set Marked value- Parameters:
marked
- value to add
-
setMarkedProperty
public void setMarkedProperty(BooleanType marked)
Set Marked property- Parameters:
marked
- Marked property to set
-
getMarkedProperty
public BooleanType getMarkedProperty()
Get Marked property- Returns:
- Marked property
-
getMarked
public java.lang.Boolean getMarked()
Get Marked value- Returns:
- marked value
-
addUsageTerms
public void addUsageTerms(java.lang.String lang, java.lang.String value)
Add an usageTerms value- Parameters:
lang
- concerned languagevalue
- value to set
-
setUsageTerms
public void setUsageTerms(java.lang.String terms)
Set the default usage terms for this resource.- Parameters:
terms
- The resource usage terms.
-
getUsageTermsProperty
public ArrayProperty getUsageTermsProperty()
Return the Lang alt UsageTerms- Returns:
- usageterms property
-
getUsageTermsLanguages
public java.util.List<java.lang.String> getUsageTermsLanguages()
Return a list of languages defined in description property- Returns:
- list of languages defined for usageterms
-
getUsageTerms
public java.lang.String getUsageTerms(java.lang.String lang)
Return a language value for description property- Parameters:
lang
- concerned language- Returns:
- value of specified language
-
getUsageTerms
public java.lang.String getUsageTerms()
Get the default usage terms for the document.- Returns:
- The terms for this resource.
-
getWebStatementProperty
public TextType getWebStatementProperty()
Return the WebStatement URL as TextType.- Returns:
- Webstatement URL property
-
getWebStatement
public java.lang.String getWebStatement()
Return the WebStatement URL as String.- Returns:
- webStatement URL value
-
setWebStatement
public void setWebStatement(java.lang.String url)
Set the WebStatement url- Parameters:
url
- WebStatemen url value to set
-
setWebStatementProperty
public void setWebStatementProperty(URLType url)
Set the WebStatement url- Parameters:
url
- WebStatemen url property to set
-
getCertificateProperty
public TextType getCertificateProperty()
Return the Certificate URL as TextType.- Returns:
- certificate url property
-
getCertificate
public java.lang.String getCertificate()
Return the Certificate URL as String.- Returns:
- certificate URL value
-
setCertificate
public void setCertificate(java.lang.String url)
Set the Certificate URL.- Parameters:
url
- certificate url value to set
-
setCertificateProperty
public void setCertificateProperty(URLType url)
Set the Certificate URL.- Parameters:
url
- certificate url property to set
-
-