Skip navigation links

oracle.irm.engine.types.core.status
Class StatusPageInformation

java.lang.Object
oracle.irm.engine.types.core.status.StatusPageInformation

All Implemented Interfaces:

Serializable

public class StatusPageInformation

extends Object

implements Serializable

Status Page Information type. 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.

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>

See Also:

Serialized Form

Constructor Summary

StatusPageInformation()
No argument constructor.

StatusPageInformation(Label system, Label classification, Label content, HyperLink[] links)
Constructor.

Method Summary

Label	getClassification() Classification label.
Label	getContent() Content label.
HyperLink[]	getLinks() Further assistance links.
Label	getSystem() System label.
void	setClassification(Label value) Classification label.
void	setContent(Label value) Content label.
void	setLinks(HyperLink[] value) Further assistance links.
void	setSystem(Label value) System label.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StatusPageInformation

public StatusPageInformation()

No argument constructor.

StatusPageInformation

public StatusPageInformation(Label system,
                             Label classification,
                             Label content,
                             HyperLink[] links)

Constructor.

Method Detail

getSystem

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

setSystem

public void setSystem(Label value)

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.

Parameters:

value - the new value for the property.

getClassification

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

setClassification

public void setClassification(Label value)

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.

Parameters:

value - the new value for the property.

getContent

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

setContent

public void setContent(Label value)

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.

Parameters:

value - the new value for the property.

getLinks

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

Returns:

the value of the property.

setLinks

public void setLinks(HyperLink[] value)

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.

Parameters:

value - the new value for the property.

Skip navigation links