Package de.xima.fc.workflow

Class ElementPrototypeDescriptor<TData,TPayload extends IElementPrototypeData<TData>>

java.lang.Object

de.xima.fc.workflow.ElementPrototypeDescriptor<TData,TPayload>

Type Parameters:

TData - Type of the workflow element's properties model.

TPayload - Type of the node or trigger data provided by this prototype.

All Implemented Interfaces:

IElementPrototypeDescriptor<TData>, Serializable

Direct Known Subclasses:

NodePrototypeDescriptor, TriggerPrototypeDescriptor

public class ElementPrototypeDescriptor<TData,TPayload extends IElementPrototypeData<TData>>
extends Object
implements IElementPrototypeDescriptor<TData>, Serializable

Default POJO implementation of IElementPrototypeDescriptor.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ElementPrototypeDescriptor(TPayload payload, String label, IGuiIcon icon, String subLabel, String title, String sortKey, IElementCategory mainCategory, IElementCategory subCategory, Set<EElementPrototypeTag> tags, String searchText)	Creates a new POJO with the given data.

Method Summary

Modifier and Type	Method	Description
IGuiIcon	getIcon()
String	getLabel()
IElementCategory	getMainCategory()
TPayload	getPayload()
String	getSearchText()
String	getSortKey()	Returns the sort key for element prototypes that are in the same IElementPrototypeDescriptor.getSubCategory().
IElementCategory	getSubCategory()	(Optional)
String	getSubLabel()
Set<EElementPrototypeTag>	getTags()
String	getTitle()

Methods inherited from class java.lang.Object

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

Constructor Detail

ElementPrototypeDescriptor

public ElementPrototypeDescriptor(TPayload payload,
                                  String label,
                                  IGuiIcon icon,
                                  String subLabel,
                                  String title,
                                  String sortKey,
                                  IElementCategory mainCategory,
                                  IElementCategory subCategory,
                                  Set<EElementPrototypeTag> tags,
                                  String searchText)

Creates a new POJO with the given data.

Parameters:

payload - The value returned by IElementPrototypeDescriptor.getPayload().

label - The value returned by IElementPrototypeDescriptor.getLabel().

icon - The value returned by IElementPrototypeDescriptor.getIcon().

subLabel - The value returned by IElementPrototypeDescriptor.getSubLabel().

title - The value returned by IElementPrototypeDescriptor.getTitle().

sortKey - The value returned by IElementPrototypeDescriptor.getSortKey().

mainCategory - The value returned by IElementPrototypeDescriptor.getMainCategory().

subCategory - The value returned by IElementPrototypeDescriptor.getSubCategory().

tags - The value returned by IElementPrototypeDescriptor.getTags().

searchText - The value returned by IElementPrototypeDescriptor.getSearchText().

Method Detail

getIcon

public IGuiIcon getIcon()

Specified by:

getIcon in interface IElementPrototypeDescriptor<TData>

Returns:

The icon for this element prototype, as shown in the UI.

getLabel

public String getLabel()

Specified by:

getLabel in interface IElementPrototypeDescriptor<TData>

Returns:

The localized name of the prototype item, as shown in the UI.

getMainCategory

public IElementCategory getMainCategory()

Specified by:

getMainCategory in interface IElementPrototypeDescriptor<TData>

Returns:

IElementCategory element's main category, which is used for grouping the elements.

getPayload

public TPayload getPayload()

Specified by:

getPayload in interface IElementPrototypeDescriptor<TData>

Returns:

The data for this element prototype that is used for creating a new workflow element.

getSearchText

public String getSearchText()

Specified by:

getSearchText in interface IElementPrototypeDescriptor<TData>

Returns:

A text that is never visible to the user, but only used when searching for an element, such as via a search input field in the UI.

getSortKey

public String getSortKey()

Description copied from interface: IElementPrototypeDescriptor

Returns the sort key for element prototypes that are in the same IElementPrototypeDescriptor.getSubCategory(). Each prototype belongs to a category and is shown in that category (which may be a tab, accordion panel etc.) When there are multiple element prototypes in the same category, they are sorted according to their IElementPrototypeDescriptor.getSortKey().

Specified by:

getSortKey in interface IElementPrototypeDescriptor<TData>

Returns:

The key for sorting items in the same IElementPrototypeDescriptor.getSubCategory().

getSubCategory

public IElementCategory getSubCategory()

Description copied from interface: IElementPrototypeDescriptor

(Optional)

Specified by:

getSubCategory in interface IElementPrototypeDescriptor<TData>

Returns:

IElementCategory element's sub category, which is used for grouping the element within the given main group.

getSubLabel

public String getSubLabel()

Specified by:

getSubLabel in interface IElementPrototypeDescriptor<TData>

Returns:

The localized sub label of the prototype item. The sub label, when not empty, is shown below the label in a smaller font size and may provide additional details about the item.

getTags

public Set<EElementPrototypeTag> getTags()

Specified by:

getTags in interface IElementPrototypeDescriptor<TData>

Returns:

List of tags for this prototype that may affect when this prototype is visible etc.

getTitle

public String getTitle()

Specified by:

getTitle in interface IElementPrototypeDescriptor<TData>

Returns:

The localized title for the prototype item. The title is the tooltip that shows up when the user hovers over the item with the mouse.