com.ur.urcap.api.contribution

Interface InstallationNodeService

public interface InstallationNodeService

Defines an API required for definition of an installation node and screen of a URCap.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
InstallationNodeContribution	createInstallationNode(URCapAPI api, DataModel model) Creates a new installation node instance.
InputStream	getHTML()
String	getTitle()

Method Detail

getTitle

String getTitle()

Returns:

The text displayed for this URCap in the Installation Tab.

getHTML

InputStream getHTML()

Returns:

Return an input stream with the HTML contents of the node.

createInstallationNode

InstallationNodeContribution createInstallationNode(URCapAPI api,
                                                    DataModel model)

Creates a new installation node instance.

The returned node must use the supplied data model object to retrieve and store the data contained in it. All modifications to the supplied data model from the installation node constructor are ignored when an existing installation is loaded. The data model object is shared between all installation nodes contributed by the same URCap.

Parameters:

api - object with access to PolyScope functionality.

model - object where all configuration data of the new installation node. instance is to be stored in and retrieved from.

Returns:

the newly constructed installation node contribution instance.