Skip navigation links

oracle.irm.engine.types.core.feature
Class Feature

java.lang.Object
oracle.irm.engine.types.core.feature.Feature

All Implemented Interfaces:

Serializable

public class Feature

extends Object

implements Serializable

Feature type.

XML Serialization

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

<?xml version="1.0" encoding="UTF-8"?>
<core:Feature xmlns:core="http://xmlns.oracle.com/irm/core">
<id>oracle.irm.generic.Open</id>
<use>IMMEDIATE</use>
<record>true</record>
</core:Feature>

See Also:

Serialized Form

Nested Class Summary

static class	Feature.Support Support enumeration.
static class	Feature.Use Use enumeration.

Constructor Summary

Feature()
No argument constructor.

Feature(String id, Feature.Use use, boolean record)
Constructor.

Method Summary

String	getId() The feature identity.
boolean	getRecord() Whether use of this feature is recorded.
Feature.Use	getUse() How this feature is obtained.
void	setId(String value) The feature identity.
void	setRecord(boolean value) Whether use of this feature is recorded.
void	setUse(Feature.Use value) How this feature is obtained.

Methods inherited from class java.lang.Object

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

Constructor Detail

Feature

public Feature()

No argument constructor.

Feature

public Feature(String id,
               Feature.Use use,
               boolean record)

Constructor.

Method Detail

getId

public String getId()

The feature identity. The feature identity is a unique string that identifies the feature. e.g. oracle.irm.generic.Open. Feature identities must be globally unique. Features that the desktop does not understand are ignored.

Size

This property is limited to 50 characters in length.

Returns:

the value of the property.

setId

public void setId(String value)

The feature identity. The feature identity is a unique string that identifies the feature. e.g. oracle.irm.generic.Open. Feature identities must be globally unique. Features that the desktop does not understand are ignored.

Size

This property is limited to 50 characters in length.

Parameters:

value - the new value for the property.

getUse

public Feature.Use getUse()

How this feature is obtained. An immediate feature is one that is available for use as soon as content is accessed. An on demand feature is one that is on offer for use, but has to be obtained before it can be used. e.g. An immediate feature might be to open content, and once opened may offer print the content as a on demand feature. If printing is required the desktop must obtain the rights to print (by requesting licenses).

Returns:

the value of the property.

setUse

public void setUse(Feature.Use value)

How this feature is obtained. An immediate feature is one that is available for use as soon as content is accessed. An on demand feature is one that is on offer for use, but has to be obtained before it can be used. e.g. An immediate feature might be to open content, and once opened may offer print the content as a on demand feature. If printing is required the desktop must obtain the rights to print (by requesting licenses).

Parameters:

value - the new value for the property.

getRecord

public boolean getRecord()

Whether use of this feature is recorded. When an application feature is used the event can be recorded. Feature use can be recorded on-line and off-line. Off-line feature usage is uploaded when the desktop comes back on-line.

Returns:

the value of the property.

See Also:

JournalEntry

setRecord

public void setRecord(boolean value)

Whether use of this feature is recorded. When an application feature is used the event can be recorded. Feature use can be recorded on-line and off-line. Off-line feature usage is uploaded when the desktop comes back on-line.

Parameters:

value - the new value for the property.

See Also:

JournalEntry

Skip navigation links