Skip navigation links

oracle.irm.engine.types.rights.context
Class DocumentRoleRef

java.lang.Object
oracle.irm.engine.types.rights.context.DocumentRoleRef

All Implemented Interfaces:

Serializable

public class DocumentRoleRef

extends Object

implements Serializable

Document Role reference. A document role defines what features of the IRM Desktop a user can perform. It includes details such as what features are audited, the elapsed time a document can be used off-line, item constraints and time constraints.

This class can be used to reference an instance of a DocumentRole object. It contains all the properties needed to uniquely identify a DocumentRole. The serialized form of this class can be used to identify an object without the need to serialize the complete object.

XML Serialization

Document Role instances can be serialized as an XML document. This XML document can also be used to recreate a Document Role object. The following XML document shows an example Document Role in XML form.

<?xml version="1.0" encoding="UTF-8"?>
<rights:DocumentRole xmlns:rights="http://xmlns.oracle.com/irm/rights" xmlns:core="http://xmlns.oracle.com/irm/core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<uuid>c70e0920-a957-47e2-b045-7210acd758ee</uuid>
<labels>
<locale>en</locale>
<name>Reader</name>
</labels>
<storage>PERSISTENT</storage>
<features>
<id>oracle.irm.generic.Open</id>
<use>IMMEDIATE</use>
<record>true</record>
</features>
<timeSpans xsi:type="core:AbsoluteTimeSpan">
<referencePoint>CURRENT</referencePoint>
<startTime>2007-05-10T12:00:00.000+01:00</startTime>
<stopTime>2008-05-10T12:00:00.000+01:00</stopTime>
</timeSpans>
<refreshPeriod>
<amount>2</amount>
<units>HOURS</units>
</refreshPeriod>
<itemConstraints>EXCLUSIONS</itemConstraints>
<exportConstraints>NONE</exportConstraints>
<domain>
<uuid>97bdf4f1-1375-4b28-9520-17a23503462f</uuid>
</domain>
</rights:DocumentRole>

Document Role instances can also be serialized by reference. A reference contains all the information needed to uniquely identify a Document Role without needing to serialize the complete object. The reference form of the XML document can be seen below.

<?xml version="1.0" encoding="UTF-8"?>
<rights:DocumentRoleRef xmlns:rights="http://xmlns.oracle.com/irm/rights">
<uuid>c70e0920-a957-47e2-b045-7210acd758ee</uuid>
<domain>
<uuid>97bdf4f1-1375-4b28-9520-17a23503462f</uuid>
</domain>
</rights:DocumentRoleRef>

See Also:

Serialized Form

Constructor Summary

DocumentRoleRef()
No argument constructor.

DocumentRoleRef(UUID uuid, DomainRef domain)
Constructor.

Method Summary

DomainRef	getDomain() The domain that owns this role.
UUID	getUuid() Role UUID.
void	setDomain(DomainRef value) The domain that owns this role.
void	setUuid(UUID value) Role UUID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentRoleRef

public DocumentRoleRef()

No argument constructor.

DocumentRoleRef

public DocumentRoleRef(UUID uuid,
                       DomainRef domain)

Constructor.

Method Detail

getUuid

public UUID getUuid()

Role UUID.

Returns:

the value of the property.

setUuid

public void setUuid(UUID value)

Role UUID.

Parameters:

value - the new value for the property.

getDomain

public DomainRef getDomain()

The domain that owns this role. Document roles must have an unique Uuid within a domain.

Returns:

the value of the property.

setDomain

public void setDomain(DomainRef value)

The domain that owns this role. Document roles must have an unique Uuid within a domain.

Parameters:

value - the new value for the property.

Skip navigation links