Skip navigation links

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

java.lang.Object
oracle.irm.engine.types.classifications.context.Context
oracle.irm.engine.types.rights.context.ContextInstance

All Implemented Interfaces:

Serializable

public class ContextInstance

extends Context

implements Serializable

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

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, Serialized Form

Nested Class Summary

static class	ContextInstance.Role Role enumeration.
static class	ContextInstance.Visibility Visibility enumeration.

Constructor Summary

ContextInstance()
No argument constructor.

ContextInstance(UUID uuid, Label[] labels, ItemCode[] items, ContextInstanceRef[] trustedContexts, ContextInstance.Visibility visibility, ContextTemplateRef template)
Constructor.

Method Summary

ItemCode[]	getItems() Context level item exclusions.
Label[]	getLabels() Labels for the context.
ContextTemplateRef	getTemplate() The context template.
ContextInstanceRef[]	getTrustedContexts() Trusted contexts.
ContextInstance.Visibility	getVisibility() Context visibility.
void	setItems(ItemCode[] value) Context level item exclusions.
void	setLabels(Label[] value) Labels for the context.
void	setTemplate(ContextTemplateRef value) The context template.
void	setTrustedContexts(ContextInstanceRef[] value) Trusted contexts.
void	setVisibility(ContextInstance.Visibility value) Context visibility.

Methods inherited from class oracle.irm.engine.types.classifications.context.Context

getUuid, setUuid

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextInstance

public ContextInstance()

No argument constructor.

ContextInstance

public ContextInstance(UUID uuid,
                       Label[] labels,
                       ItemCode[] items,
                       ContextInstanceRef[] trustedContexts,
                       ContextInstance.Visibility visibility,
                       ContextTemplateRef template)

Constructor.

Method Detail

getLabels

public 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.

Returns:

the value of the property.

setLabels

public void setLabels(Label[] value)

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.

Parameters:

value - the new value for the property.

getItems

public 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.

Returns:

the value of the property.

setItems

public void setItems(ItemCode[] value)

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.

Parameters:

value - the new value for the property.

getTrustedContexts

public ContextInstanceRef[] 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.

Returns:

the value of the property.

setTrustedContexts

public void setTrustedContexts(ContextInstanceRef[] value)

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.

Parameters:

value - the new value for the property.

getVisibility

public 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.

setVisibility

public void setVisibility(ContextInstance.Visibility value)

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.

Parameters:

value - the new value for the property.

getTemplate

public ContextTemplateRef 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.

setTemplate

public void setTemplate(ContextTemplateRef value)

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

Parameters:

value - the new value for the property.

Skip navigation links