de.xima.fc.plugin.interfaces.form

Interface IPluginFormElementCatalogue

All Superinterfaces:

IFCPlugin, INameProviding, ITransferable, Serializable

public interface IPluginFormElementCatalogue
extends IFCPlugin

Interface for plugins to integrate own catalogue elements within the designer

Author:

XIMA MEDIA GmbH, Dresden - Thomas Löwe - 10.08.2017

Field Summary

Fields inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

CONFIG_FILENAME

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding

ATTR_NAME

Method Summary

Modifier and Type	Method and Description
com.alibaba.fastjson.JSONArray	getCatalogueData(String catalogueId, Locale locale)
com.alibaba.fastjson.JSONArray	getCatalogueList(Locale locale)
String	getCatalogueName(Locale locale)
String	getId()

Methods inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

getDescription, getName, initialize, initPlugin, install, shutdown, shutdown, uninstall

Method Detail

getCatalogueData

com.alibaba.fastjson.JSONArray getCatalogueData(String catalogueId,
                                                Locale locale)

Parameters:

catalogueId - An ID of the catalogue, as returned by getCatalogueList(Locale)

locale - The locale for which the catalogue should be returned. May be used for locale-specific catalogues.

Returns:

The catalogue data.

getCatalogueList

com.alibaba.fastjson.JSONArray getCatalogueList(Locale locale)

Returns:

A List of available catalogues.

getCatalogueName

String getCatalogueName(Locale locale)

Parameters:

locale - The Locale that may be used for locale-specific catalogues.

Returns:

The name of this catalogue plugin.

getId

String getId()

Returns:

The ID of this catalogue plugin.