Skip navigation links

oracle.irm.engine.rights.context
Interface DocumentRole

public interface DocumentRole

Context classified document role. 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.

Creation

Instances of Document Role objects can be created using the following factory style method(s).

DocumentRole object = createDocumentRole(
    uuid,
    domain);

DocumentRole object = createDocumentRole(
    uuid,
    labels,
    storage,
    features,
    timeSpans,
    refreshPeriod,
    itemConstraints,
    exportConstraints,
    domain);

Collections

Collections for DocumentRole objects can be created using the following factory method. This method creates the most appropriate collection implementation class for storing DocumentRole elements.

 Collection<DocumentRole> object = createDocumentRoles();

Consult the Uuid property for more information on how this property can relate to DocumentRole collections.

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>

Nested Class Summary

static class	DocumentRole.ExportConstraints Export constraint options.
static class	DocumentRole.TimeConstraints Time constraint common use cases.

Method Summary

Domain	getDomain() The domain that owns this role.
DocumentRole.ExportConstraints	getExportConstraints() Set the export constraints on a role.
Collection<Feature>	getFeatures() The valid features.
ItemConstraints.Type	getItemConstraints() Item constraints.
Collection<Label>	getLabels() Role labels.
TimePeriod	getRefreshPeriod() The refresh period.
LicenseCriteria.Storage	getStorage() Storage specifier.
Collection<TimeSpan>	getTimeSpans() Time constraints.
UUID	getUuid() Role UUID.

Method Detail

getUuid

UUID getUuid()

Role UUID.

Collections

This property value can be used to retrieve the object from a collection using getDocumentRoleByUuid.

Returns:

the value of the property. This method will never return null.

getLabels

Collection<Label> getLabels()

Role labels. A set of names and descriptions for the role.

State

The collection returned by this method is an unmodifiable view on the internal collection state of the object.

Returns:

the value of the property. If this collection is empty this method returns an empty collection rather than returning null.

getStorage

LicenseCriteria.Storage getStorage()

Storage specifier. Whether this role allows off-line working (persistent storage) or not.

Returns:

the value of the property. This method will never return null.

getFeatures

Collection<Feature> getFeatures()

The valid features. The list of features this role allows.

State

The collection returned by this method is an unmodifiable view on the internal collection state of the object.

Returns:

the value of the property. If this collection is empty this method returns an empty collection rather than returning null.

getTimeSpans

Collection<TimeSpan> getTimeSpans()

Time constraints.

State

The collection returned by this method is an unmodifiable view on the internal collection state of the object.

Returns:

the value of the property. If this collection is empty this method returns an empty collection rather than returning null.

getRefreshPeriod

TimePeriod getRefreshPeriod()

The refresh period. How long this role can be used before the server must be re-contacted.

Returns:

the value of the property. This method can return null.

getItemConstraints

ItemConstraints.Type getItemConstraints()

Item constraints. The type of item constraints that can be applied to rights assigned from this role.

Returns:

the value of the property. This method will never return null.

getExportConstraints

DocumentRole.ExportConstraints getExportConstraints()

Set the export constraints on a role. Export constraints control how sealed content can be resealed to other classifications, or copied between sealed content. Altering the export constraints of a document role automatically adds (or removes) the appropriate Feature definitions to the role that infer those export constraints. This methods is provided as an alternative way to adding or removing features manually to/from the document role.

Returns:

the value of the property. This method will never return null.

getDomain

Domain getDomain()

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

Returns:

the value of the property. This method can return null.

Skip navigation links