Skip navigation links

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

E12907-02


oracle.irm.engine.core.status
Interface StatusPageInformation


public interface StatusPageInformation

Status page information. Represents information displayed on a status page. This information contains details about the system, the classification, the content and further information links. This information is derived from the DesktopState passed from the desktop to the server.

Creation

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

StatusPageInformation object = createStatusPageInformation(
    system,
    classification,
    content,
    links);

XML Serialization

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

<?xml version="1.0" encoding="UTF-8"?>
<core:StatusPageInformation xmlns:core="http://xmlns.oracle.com/irm/core">
    <system>
        <locale>en</locale>
        <name>Oracle</name>
    </system>
    <classification>
        <locale>en</locale>
        <name>Top Secret</name>
        <description>This is a top secret classification.</description>
    </classification>
    <content>
        <locale>en</locale>
        <name>Top Secret.sdoc</name>
    </content>
    <links>
        <label>
            <locale>en</locale>
            <name>John Smith</name>
        </label>
        <uri>mailto:john.smith@example.com</uri>
    </links>
</core:StatusPageInformation>


Method Summary
 Label getClassification()
          Classification label.
 Label getContent()
          Content label.
 Collection<HyperLink> getLinks()
          Further assistance links.
 Label getSystem()
          System label.

 

Method Detail

getSystem

Label getSystem()
System label. The system label typically identifies the installation or company name. e.g. it might show the Domain name if the content is sealed using the context classification system.
Returns:
the value of the property. This method will never return null.

getClassification

Label getClassification()
Classification label. The classification label typically identifies the classification in general terms. e.g. it might show the Context name if the content is sealed using the context classification system.
Returns:
the value of the property. This method can return null.

getContent

Label getContent()
Content label. The content label typically identifies the content by name. e.g. it might show the ItemCode value if the content is sealed using the context classification system.
Returns:
the value of the property. This method can return null.

getLinks

Collection<HyperLink> getLinks()
Further assistance links. Part of the information displayed on a status page is a list of links displayed under the title of 'Further Assistance'. This list typically contains one or more email addresses for the individuals that administer the installation or manage the Classification. Providing further assistance links is optional.

The desktop application also understands a number of special links called sinfo links. The list of supported links is as follows:

sinfo:reason - displays a detailed reason why the status page is being displayed.

sinfo:panel - displays the desktop control panel.

sinfo:test - displays the desktop self-test page.

sinfo:help - displays help.

sinfo:reload - reloads the sealed content.

State

The collection returned by this method is an unmodifiable view on the internal collection state of the object.
Returns:
the value of the property. If this collection is empty this method returns an empty collection rather than returning null.

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.