Skip navigation links

oracle.irm.engine.rights.context
Interface ContextInstance

All Superinterfaces:

Context

public interface ContextInstance

extends Context

A context created from a template. A Context created from ContextTemplate has a number of additional properties relating to Domain administration and ItemCode usage.

Creation

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

ContextInstance object = createContextInstance(uuid);

ContextInstance object = createContextInstance(
    uuid,
    labels,
    items,
    trustedContexts,
    visibility,
    template);

ContextInstance object = createContextInstance(
    uuid,
    labels,
    items,
    trustedContexts,
    visibility,
    keySets,
    template);

Collections

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

 Collection<ContextInstance> object = createContextInstances();

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

XML Serialization

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

<?xml version="1.0" encoding="UTF-8"?>
<rights:ContextInstance xmlns:rights="http://xmlns.oracle.com/irm/rights">
<uuid>588403f9-9cff-4cce-88e4-e030cc57282a</uuid>
<labels>
<locale>en</locale>
<name>Top Secret</name>
<description>This is a top secret context</description>
</labels>
<items>
<value>document1.sdoc</value>
</items>
<items>
<value>document2.sdoc</value>
</items>
<trustedContexts>
<uuid>588403f9-9cff-4cce-88e4-e030cc57282a</uuid>
</trustedContexts>
<visibility>CONTEXT</visibility>
<template>
<uuid>6c58fdc2-80fd-4d3a-9394-74fe873ed705</uuid>
<domain>
<uuid>97bdf4f1-1375-4b28-9520-17a23503462f</uuid>
</domain>
</template>
</rights:ContextInstance>

Context Instance instances can also be serialized by reference. A reference contains all the information needed to uniquely identify a Context Instance 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:ContextInstanceRef xmlns:rights="http://xmlns.oracle.com/irm/rights">
<uuid>588403f9-9cff-4cce-88e4-e030cc57282a</uuid>
</rights:ContextInstanceRef>

See Also:

saveChangesToContext, createContextFromTemplate

Nested Class Summary

static class	ContextInstance.Role Roles within a context.
static class	ContextInstance.Visibility Context visibility.

Method Summary

Collection<ItemCode>	getItems() Context level item exclusions.
Collection<KeySet>	getKeySets() Key sets.
Collection<Label>	getLabels() Labels for the context.
ContextTemplate	getTemplate() The context template.
Collection<ContextInstance>	getTrustedContexts() Trusted contexts.
ContextInstance.Visibility	getVisibility() Context visibility.

Methods inherited from interface oracle.irm.engine.classifications.context.Context

getUuid

Method Detail

getLabels

Collection<Label> getLabels()

Labels for the context. A context must have at least one name and description for the default language. Alternative names and descriptions can be provided for localized languages.

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.

getItems

Collection<ItemCode> getItems()

Context level item exclusions. Document related rights can include individual account based ItemCode inclusions and exclusions. However, if a document is accidently released and needs to be excluded for all accounts, Context level item exclusions can be used.

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.

getTrustedContexts

Collection<ContextInstance> getTrustedContexts()

Trusted contexts. The list of contexts that can be used for resealing. i.e. the list of contexts that can be specified as the destination classification when resealing content sealed to this context.

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.

getVisibility

ContextInstance.Visibility getVisibility()

Context visibility. Inspectors are able to view all Context instances and examine details such as account rights. Context can be hidden from inspectors. e.g. if the Context was for mergers and acquisitions it may need to be hidden from domain level inspectors. The default is that a Context is visible to domain level users such as inspectors.

Returns:

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

getKeySets

Collection<KeySet> getKeySets()

Key sets. This property lists all the key sets that are available for use with this context. Only these key sets can be specified when sealing content for this context.

Transient

This property is transient and will not be serialized (e.g into XML, remote method calls).

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.

getTemplate

ContextTemplate getTemplate()

The context template. This property represents the relationship between the context and the context template. This relationship is set when the context is created.

Returns:

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

Skip navigation links