org.eclipse.osbp.runtime.common.help

Interface IHelpService

public interface IHelpService

The Interface IHelpService.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP__DATA Is used in the properties to pass any kind of data.
static String	PROP__HELP_TYPE Is used in the properties to define the helpType.
static String	PROP__ID Is used in the properties to define the id of the given data.
static String	TYPE__TASK The type of the help is a task help.

Method Summary

Modifier and Type	Method and Description
String	getHtml(Map<String,Object> request) Returns the help content in html format.

Field Detail

PROP__HELP_TYPE

static final String PROP__HELP_TYPE

Is used in the properties to define the helpType.

See Also:

Constant Field Values

PROP__DATA

static final String PROP__DATA

Is used in the properties to pass any kind of data.

See Also:

Constant Field Values

PROP__ID

static final String PROP__ID

Is used in the properties to define the id of the given data. The implementation is responsible to provide a mechanism to convert the given id to the underlying logic.

See Also:

Constant Field Values

TYPE__TASK

static final String TYPE__TASK

The type of the help is a task help.

See Also:

Constant Field Values

Method Detail

getHtml

String getHtml(Map<String,Object> request)

Returns the help content in html format.

Parameters:

request - The help content to be converted to html

Returns:

the html