Skip navigation links

oracle.irm.engine.core.feature
Interface Feature

public interface Feature

An operation that can be performed on content, such as opening or printing.

Creation

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

Feature object = createFeature(id);

Feature object = createFeature(
    id,
    use,
    record);

Collections

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

 Collection<Feature> object = createFeatures();

Consult the Id property for more information on how this property can relate to Feature collections.

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>

Nested Class Summary

static class	Feature.Support Feature support.
static class	Feature.Use How this feature's usage is advertised to the user.

Method Summary

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

Method Detail

getId

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.

Collections

This property value can be used to retrieve the object from a collection using getFeatureById.

Returns:

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

getUse

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. This method will never return null.

getRecord

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

Skip navigation links