Skip navigation links

oracle.irm.engine.core.general
Interface HyperLink

public interface HyperLink

A hyper-link. A hyper-link contains all the information required to present a hyper link to a user - the URI, a name and an optional description.

Creation

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

HyperLink object = createHyperLink(
    label,
    uri);

Collections

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

 Collection<HyperLink> object = createHyperLinks();

XML Serialization

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

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

Method Summary

Label	getLabel() The label.
URI	getUri() The hyper-link URI.

Method Detail

getLabel

Label getLabel()

The label. The label contains a name and an optional description. The user of the hyper link is free to decide how to use this information.

Returns:

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

getUri

URI getUri()

The hyper-link URI.

Returns:

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

Skip navigation links