Skip navigation links

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

java.lang.Object
oracle.irm.engine.types.rights.context.ContextTemplate

All Implemented Interfaces:

Serializable

public class ContextTemplate

extends Object

implements Serializable

Context Template type. A context template provides a template structure for creating a ContextInstance. The template supplies the default labels for a context and the list of DocumentRole definitions available to the context manager. A ContextInstance has a permanent link back to the context template. If changes are made to the roles in the template, they immediately take effect in the context. This allows new role definitions that are added to the template to immediately be available for use in the context.

XML Serialization

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

<?xml version="1.0" encoding="UTF-8"?>
<rights:ContextTemplate xmlns:rights="http://xmlns.oracle.com/irm/rights">
<uuid>6c58fdc2-80fd-4d3a-9394-74fe873ed705</uuid>
<labels>
<locale>en</locale>
<name>Standard Template</name>
<description>This is the standard template</description>
</labels>
<status>ACTIVE</status>
<roles>
<uuid>c70e0920-a957-47e2-b045-7210acd758ee</uuid>
<domain>
<uuid>97bdf4f1-1375-4b28-9520-17a23503462f</uuid>
</domain>
</roles>
<domain>
<uuid>97bdf4f1-1375-4b28-9520-17a23503462f</uuid>
</domain>
</rights:ContextTemplate>

Context Template instances can also be serialized by reference. A reference contains all the information needed to uniquely identify a Context Template 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:ContextTemplateRef xmlns:rights="http://xmlns.oracle.com/irm/rights">
<uuid>6c58fdc2-80fd-4d3a-9394-74fe873ed705</uuid>
<domain>
<uuid>97bdf4f1-1375-4b28-9520-17a23503462f</uuid>
</domain>
</rights:ContextTemplateRef>

See Also:

Serialized Form

Nested Class Summary

static class

ContextTemplate.Status Status enumeration.

Constructor Summary

ContextTemplate()
No argument constructor.

ContextTemplate(UUID uuid, Label[] labels, ContextTemplate.Status status, DocumentRoleRef[] roles, DomainRef domain)
Constructor.

Method Summary

DomainRef	getDomain() The domain that owns this context template.
Label[]	getLabels() Template labels.
DocumentRoleRef[]	getRoles() Document roles.
ContextTemplate.Status	getStatus() Template status.
UUID	getUuid() An UUID for the template.
void	setDomain(DomainRef value) The domain that owns this context template.
void	setLabels(Label[] value) Template labels.
void	setRoles(DocumentRoleRef[] value) Document roles.
void	setStatus(ContextTemplate.Status value) Template status.
void	setUuid(UUID value) An UUID for the template.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextTemplate

public ContextTemplate()

No argument constructor.

ContextTemplate

public ContextTemplate(UUID uuid,
                       Label[] labels,
                       ContextTemplate.Status status,
                       DocumentRoleRef[] roles,
                       DomainRef domain)

Constructor.

Method Detail

getUuid

public UUID getUuid()

An UUID for the template.

Returns:

the value of the property.

setUuid

public void setUuid(UUID value)

An UUID for the template.

Parameters:

value - the new value for the property.

getLabels

public Label[] getLabels()

Template labels. The labels provide a default set of names and descriptions for a Context created from this template.

Returns:

the value of the property.

setLabels

public void setLabels(Label[] value)

Template labels. The labels provide a default set of names and descriptions for a Context created from this template.

Parameters:

value - the new value for the property.

getStatus

public ContextTemplate.Status getStatus()

Template status. The default value is for a template to be in-active.

Returns:

the value of the property.

setStatus

public void setStatus(ContextTemplate.Status value)

Template status. The default value is for a template to be in-active.

Parameters:

value - the new value for the property.

getRoles

public DocumentRoleRef[] getRoles()

Document roles. The set of document roles that can be assign to account.

Returns:

the value of the property.

setRoles

public void setRoles(DocumentRoleRef[] value)

Document roles. The set of document roles that can be assign to account.

Parameters:

value - the new value for the property.

getDomain

public DomainRef getDomain()

The domain that owns this context template.

Returns:

the value of the property.

setDomain

public void setDomain(DomainRef value)

The domain that owns this context template.

Parameters:

value - the new value for the property.

Skip navigation links