Skip navigation links

Oracle® Information Rights Management Server Java API Reference
11g Release 1 (11.1.1)

E12907-02


oracle.irm.engine.types.core.general
Class HyperLink

java.lang.Object
  extended by oracle.irm.engine.types.core.general.HyperLink

All Implemented Interfaces:
Serializable

public class HyperLink
extends Object
implements Serializable

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

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>

See Also:
Serialized Form

Constructor Summary
HyperLink()
          No argument constructor.
HyperLink(Label label, URI uri)
          Constructor.

 

Method Summary
 Label getLabel()
          The label.
 URI getUri()
          The hyper-link URI.
 void setLabel(Label value)
          The label.
 void setUri(URI value)
          The hyper-link URI.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

HyperLink

public HyperLink()
No argument constructor.

HyperLink

public HyperLink(Label label,
                 URI uri)
Constructor.

Method Detail

getLabel

public 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.

setLabel

public void setLabel(Label value)
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.
Parameters:
value - the new value for the property.

getUri

public URI getUri()
The hyper-link URI.
Returns:
the value of the property.

setUri

public void setUri(URI value)
The hyper-link URI.
Parameters:
value - the new value for the property.

Skip navigation links

Oracle® Information Rights Management Server Java API Reference
11g Release 1 (11.1.1)

E12907-02


Copyright © 2010, Oracle. All rights reserved.