|
Oracle® Information Rights Management Server Java API Reference 11g Release 1 (11.1.1) E12907-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.irm.engine.types.rights.context.DocumentRight
public class DocumentRight
Document Right type. A right is the outcome of assigning a DocumentRole
to an Account
. A right can also specify item restrictions specific to the account. To hinder attempts at password sharing, document role based rights that are served to the device and cannot be used until the rights are checked back in from the device (or the offline period expires).
Document Right instances can be serialized as an XML document. This XML document can also be used to recreate a Document Right object. The following XML document shows an example Document Right in XML form.
<?xml version="1.0" encoding="UTF-8"?>
<rights:DocumentRight xmlns:core="http://xmlns.oracle.com/irm/core" xmlns:rights="http://xmlns.oracle.com/irm/rights" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<uuid>926e901b-c4b8-41a7-9c28-5ce43007529</uuid>
<account>
<uuid>17f45d8d-d5c9-4970-8808-daa0fc893c33</uuid>
</account>
<role xsi:type="rights:DocumentRole">
<uuid>c70e0920-a957-47e2-b045-7210acd758ee</uuid>
<labels>
<locale>en</locale>
<name>Editor</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+00:00</startTime>
<stopTime>2008-05-10T12:00:00.000+00:00</stopTime>
</timeSpans>
<itemConstraints>EXCLUSIONS</itemConstraints>
<exportConstraints>NONE</exportConstraints>
<refreshPeriod>
<amount>2</amount>
<units>HOURS</units>
</refreshPeriod>
<domain>
<uuid>97bdf4f1-1375-4b28-9520-17a23503462f</uuid>
</domain>
</role>
<assignedTime>2007-05-11T11:47:00.000+01:00</assignedTime>
<itemCodes>
<value>test.sxls</value>
</itemCodes>
<context>
<uuid>97bdf4f1-1375-4b28-9520-17a23503462f</uuid>
</context>
</rights:DocumentRight>
Document Right instances can also be serialized by reference. A reference contains all the information needed to uniquely identify a Document Right 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:DocumentRightRef xmlns:rights="http://xmlns.oracle.com/irm/rights">
<uuid>926e901b-c4b8-41a7-9c28-5ce43007529</uuid>
</rights:DocumentRightRef>
Constructor Summary | |
---|---|
DocumentRight() No argument constructor. |
|
DocumentRight(UUID uuid, AccountRef account, DocumentRole role, Date assignedTime, ItemCode[] itemCodes, ContextInstanceRef context) Constructor. |
Method Summary | |
---|---|
AccountRef |
getAccount() The account. |
Date |
getAssignedTime() Role assignment time. |
ContextInstanceRef |
getContext() The related context. |
ItemCode[] |
getItemCodes() Item restrictions. |
DocumentRole |
getRole() The role. |
UUID |
getUuid() Globally unique right Id. |
void |
setAccount(AccountRef value) The account. |
void |
setAssignedTime(Date value) Role assignment time. |
void |
setContext(ContextInstanceRef value) The related context. |
void |
setItemCodes(ItemCode[] value) Item restrictions. |
void |
setRole(DocumentRole value) The role. |
void |
setUuid(UUID value) Globally unique right Id. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DocumentRight()
public DocumentRight(UUID uuid, AccountRef account, DocumentRole role, Date assignedTime, ItemCode[] itemCodes, ContextInstanceRef context)
Method Detail |
---|
public UUID getUuid()
public void setUuid(UUID value)
value
- the new value for the property.public AccountRef getAccount()
DocumentRole
.public void setAccount(AccountRef value)
DocumentRole
.value
- the new value for the property.public DocumentRole getRole()
Account
.public void setRole(DocumentRole value)
Account
.value
- the new value for the property.public Date getAssignedTime()
public void setAssignedTime(Date value)
value
- the new value for the property.public ItemCode[] getItemCodes()
DocumentRole
defines, this is the list of allowed or disallowed items.public void setItemCodes(ItemCode[] value)
DocumentRole
defines, this is the list of allowed or disallowed items.value
- the new value for the property.public ContextInstanceRef getContext()
Context
and only applies to documents classified against that Context
.public void setContext(ContextInstanceRef value)
Context
and only applies to documents classified against that Context
.value
- the new value for the property.
|
Oracle® Information Rights Management Server Java API Reference 11g Release 1 (11.1.1) E12907-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |