Skip navigation links

oracle.irm.engine.core.general
Interface Label

public interface Label

A label for something. A label comprises of a name and a description. The label also specifies a locale.

Creation

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

Label object = createLabel(
    locale,
    name);

Label object = createLabel(
    locale,
    name,
    description);

Collections

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

 Collection<Label> object = createLabels();

Consult the Locale property for more information on how this property can relate to Label collections.

XML Serialization

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

<?xml version="1.0" encoding="UTF-8"?>
<core:Label xmlns:core="http://xmlns.oracle.com/irm/core">
<locale>en</locale>
<name>label</name>
<description>a description</description>
</core:Label>

Method Summary

String	getDescription() Description.
Locale	getLocale() Locale.
String	getName() Name.

Method Detail

getLocale

Locale getLocale()

Locale. The intended locale for this label.

Collections

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

Returns:

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

getName

String getName()

Name. A name for the label.

Returns:

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

getDescription

String getDescription()

Description. A fuller description of what the label represents.

Returns:

the value of the property. This method can return null.

Skip navigation links