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
Representation of XMP Rights Management Schema
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
Fields inherited from class org.apache.xmpbox.type.AbstractStructuredType
STRUCTURE_ARRAY_NAME
-
Constructor Summary
ConstructorsConstructorDescriptionXMPRightsManagementSchema
(XMPMetadata metadata) Constructor of XMPRightsManagement Schema with preferred prefixXMPRightsManagementSchema
(XMPMetadata metadata, String ownPrefix) Constructor of XMPRightsManagement schema with specified prefix -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add a legal owner for the described resource.void
addUsageTerms
(String lang, String value) Add an usageTerms valueReturn the Certificate URL as String.Return the Certificate URL as TextType.Get Marked valueGet Marked propertyReturn a String list of owner(s)Return the Bag of owner(s)Get the default usage terms for the document.getUsageTerms
(String lang) Return a language value for description propertyReturn a list of languages defined in description propertyReturn the Lang alt UsageTermsReturn the WebStatement URL as String.Return the WebStatement URL as TextType.void
removeOwner
(String value) void
setCertificate
(String url) Set the Certificate URL.void
Set the Certificate URL.void
Set Marked valuevoid
setMarkedProperty
(BooleanType marked) Set Marked propertyvoid
setUsageTerms
(String terms) Set the default usage terms for this resource.void
setWebStatement
(String url) Set the WebStatement urlvoid
Set the WebStatement urlMethods 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 Details
-
CERTIFICATE
- See Also:
-
MARKED
- See Also:
-
OWNER
- See Also:
-
USAGETERMS
- See Also:
-
WEBSTATEMENT
- See Also:
-
-
Constructor Details
-
XMPRightsManagementSchema
Constructor of XMPRightsManagement Schema with preferred prefix- Parameters:
metadata
- The metadata to attach this schema
-
XMPRightsManagementSchema
Constructor of XMPRightsManagement schema with specified prefix- Parameters:
metadata
- The metadata to attach this schemaownPrefix
- The prefix to assign
-
-
Method Details
-
addOwner
Add a legal owner for the described resource.- Parameters:
value
- value to add
-
removeOwner
-
getOwnersProperty
Return the Bag of owner(s)- Returns:
- owners property
-
getOwners
Return a String list of owner(s)- Returns:
- list of defined owners
-
setMarked
Set Marked value- Parameters:
marked
- value to add
-
setMarkedProperty
Set Marked property- Parameters:
marked
- Marked property to set
-
getMarkedProperty
Get Marked property- Returns:
- Marked property
-
getMarked
Get Marked value- Returns:
- marked value
-
addUsageTerms
Add an usageTerms value- Parameters:
lang
- concerned languagevalue
- value to set
-
setUsageTerms
Set the default usage terms for this resource.- Parameters:
terms
- The resource usage terms.
-
getUsageTermsProperty
Return the Lang alt UsageTerms- Returns:
- usageterms property
-
getUsageTermsLanguages
Return a list of languages defined in description property- Returns:
- list of languages defined for usageterms
-
getUsageTerms
Return a language value for description property- Parameters:
lang
- concerned language- Returns:
- value of specified language
-
getUsageTerms
Get the default usage terms for the document.- Returns:
- The terms for this resource.
-
getWebStatementProperty
Return the WebStatement URL as TextType.- Returns:
- Webstatement URL property
-
getWebStatement
Return the WebStatement URL as String.- Returns:
- webStatement URL value
-
setWebStatement
Set the WebStatement url- Parameters:
url
- WebStatemen url value to set
-
setWebStatementProperty
Set the WebStatement url- Parameters:
url
- WebStatemen url property to set
-
getCertificateProperty
Return the Certificate URL as TextType.- Returns:
- certificate url property
-
getCertificate
Return the Certificate URL as String.- Returns:
- certificate URL value
-
setCertificate
Set the Certificate URL.- Parameters:
url
- certificate url value to set
-
setCertificateProperty
Set the Certificate URL.- Parameters:
url
- certificate url property to set
-