Skip navigation links

oracle.irm.engine.types.rights.journal
Class ContextJournalEntry

java.lang.Object
oracle.irm.engine.types.rights.journal.ContextJournalEntry

All Implemented Interfaces:

Serializable

public class ContextJournalEntry

extends Object

implements Serializable

Context Journal Entry type. A context journal entry contains a record of an action performed on sealed content of the context classification system. The context journal entry contains the Time the action that was performed, whether the action was successful or unsuccessful, which Account performed the action, what Feature was performed on the content, the ContextInstance of the content, the ItemCode of the content, the Uri source of the content and the Device the action was performed.

XML Serialization

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

<?xml version="1.0" encoding="UTF-8"?>
<rights:ContextJournalEntry xmlns:rights="http://xmlns.oracle.com/irm/rights" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../../schema/irm_rights_journal_types.xsd">
<uuid>7fabc0b0-6ece-495b-96e3-661b655b1759</uuid>
<time>2008-02-01T12:00:00.000+01:00</time>
<status>SUCCESS</status>
<account>
<uuid>17f45d8d-d5c9-4970-8808-daa0fc893c33</uuid>
<name>John Smith</name>
<type>USER</type>
</account>
<feature>
<id>oracle.irm.generic.Open</id>
<use>IMMEDIATE</use>
<record>true</record>
</feature>
<contextInstance>
<uuid>7fabc0b0-6ece-495b-96e3-661b655b1759</uuid>
</contextInstance>
<itemCode>
<value>sample.sdoc</value>
</itemCode>
<uri>http://irm.example.com/sample.sdoc</uri>
<device>
<uuid>7fabc0b0-6ece-495b-96e3-661b655b1759</uuid>
<name>machine</name>
</device>
</rights:ContextJournalEntry>

See Also:

Serialized Form

Nested Class Summary

static class

ContextJournalEntry.Status Status enumeration.

Constructor Summary

ContextJournalEntry()
No argument constructor.

ContextJournalEntry(UUID uuid, Date time, ContextJournalEntry.Status status, Account account, Feature feature, ContextInstanceRef contextInstance, ItemCode itemCode, URI uri, Device device)
Constructor.

Method Summary

Account	getAccount() The account performing the action.
ContextInstanceRef	getContextInstance() The context of the content.
Device	getDevice() The device the action was performed.
Feature	getFeature() The application feature being performed.
ItemCode	getItemCode() The item code of the content.
ContextJournalEntry.Status	getStatus() The status of the action.
Date	getTime() The time of the action.
URI	getUri() The source of the content.
UUID	getUuid() The context journal entry UUID.
void	setAccount(Account value) The account performing the action.
void	setContextInstance(ContextInstanceRef value) The context of the content.
void	setDevice(Device value) The device the action was performed.
void	setFeature(Feature value) The application feature being performed.
void	setItemCode(ItemCode value) The item code of the content.
void	setStatus(ContextJournalEntry.Status value) The status of the action.
void	setTime(Date value) The time of the action.
void	setUri(URI value) The source of the content.
void	setUuid(UUID value) The context journal entry UUID.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextJournalEntry

public ContextJournalEntry()

No argument constructor.

ContextJournalEntry

public ContextJournalEntry(UUID uuid,
                           Date time,
                           ContextJournalEntry.Status status,
                           Account account,
                           Feature feature,
                           ContextInstanceRef contextInstance,
                           ItemCode itemCode,
                           URI uri,
                           Device device)

Constructor.

Method Detail

getUuid

public UUID getUuid()

The context journal entry UUID. A unique identifier for a context journal entry.

Returns:

the value of the property.

setUuid

public void setUuid(UUID value)

The context journal entry UUID. A unique identifier for a context journal entry.

Parameters:

value - the new value for the property.

getTime

public Date getTime()

The time of the action. The context journal entry time records the time the action was performed, rather than the time the context journal entry was created.

Returns:

the value of the property.

setTime

public void setTime(Date value)

The time of the action. The context journal entry time records the time the action was performed, rather than the time the context journal entry was created.

Parameters:

value - the new value for the property.

getStatus

public ContextJournalEntry.Status getStatus()

The status of the action. Whether the context journal entry indicates a successful action on content of an unsuccessful action.

Returns:

the value of the property.

setStatus

public void setStatus(ContextJournalEntry.Status value)

The status of the action. Whether the context journal entry indicates a successful action on content of an unsuccessful action.

Parameters:

value - the new value for the property.

getAccount

public Account getAccount()

The account performing the action. The authenticated account.

Returns:

the value of the property.

setAccount

public void setAccount(Account value)

The account performing the action. The authenticated account.

Parameters:

value - the new value for the property.

getFeature

public Feature getFeature()

The application feature being performed. The feature describes the application feature being used, e.g. opening content or printing content.

Returns:

the value of the property.

See Also:

Record

setFeature

public void setFeature(Feature value)

The application feature being performed. The feature describes the application feature being used, e.g. opening content or printing content.

Parameters:

value - the new value for the property.

See Also:

Record

getContextInstance

public ContextInstanceRef getContextInstance()

The context of the content. The context of the content that this context journal entry relates to.

Returns:

the value of the property.

setContextInstance

public void setContextInstance(ContextInstanceRef value)

The context of the content. The context of the content that this context journal entry relates to.

Parameters:

value - the new value for the property.

getItemCode

public ItemCode getItemCode()

The item code of the content. The ItemCode that identifies the content that this context journal entry relates to.

Returns:

the value of the property.

setItemCode

public void setItemCode(ItemCode value)

The item code of the content. The ItemCode that identifies the content that this context journal entry relates to.

Parameters:

value - the new value for the property.

getUri

public URI getUri()

The source of the content. The source indicates where desktop application obtained the content. This is typically the file system, but also could be a HTTP or HTTPS location. The source of the content may not always be available, for example, if the action was performed on a server.

Returns:

the value of the property.

setUri

public void setUri(URI value)

The source of the content. The source indicates where desktop application obtained the content. This is typically the file system, but also could be a HTTP or HTTPS location. The source of the content may not always be available, for example, if the action was performed on a server.

Parameters:

value - the new value for the property.

getDevice

public Device getDevice()

The device the action was performed. The device gives an indication of the physical location where the action was performed.

Returns:

the value of the property.

setDevice

public void setDevice(Device value)

The device the action was performed. The device gives an indication of the physical location where the action was performed.

Parameters:

value - the new value for the property.

Skip navigation links