Package de.xima.fc.interfaces.workflow.elements

Interface IElementHelpLocation

All Superinterfaces:

Serializable

All Known Implementing Classes:

ElementHelpLocation

public interface IElementHelpLocation
extends Serializable

Models the location of the help page for a workflow element. The help page can be provided in several ways, such as via an external link of a built-in XHTML page.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
EElementHelpPageTargetType	getTargetType()
String	getValue()	Must return the help page location.

Method Details

getTargetType

EElementHelpPageTargetType getTargetType()

Returns:

The type of the help page, see EElementHelpPageTargetType for more info.

getValue

String getValue()

Must return the help page location. The exact meaning of this value depends on the getTargetType().

• EXTERNAL_LINK Must be the full, absolute link.
• OFFICIAL_HELP_PAGE Must be the relative path, e.g. /xwiki/bin/view/Formcycle/Designer/Workflow/Actions/CreateTextFile
• HTML_FILE Must be a complete HTML page, with all scripts and styles as required.

Returns:

The help page location.