IFCPlugin - Plugin Basis-Schnittstelle


IFCPlugin

Bedeutung

Die Schnittstelle IFCPlugin stellt allgemeine Funktionen zur Steuerung des Plugin-Lebenszyklus bereit. Die Schnittstelle muss bei der Entwicklung eigener Plugins nicht direkt eingebunden werden, da sie als "Basis-Schnittstelle" in allen anderen Plugin-Schnittstellen referenziert wird.

Methodensignaturen

String getName()

default String getDisplayName(Locale locale)

default String getDescription(Locale locale)

default String getDescription()

default void install(IPluginInstallData installData) throws FCPluginException

default void initialize(IPluginInitializeData initializeData) throws FCPluginException

default void shutdown(IPluginShutdownData shutdownData) throws FCPluginException

default uninstall(IPluginUninstallData uninstallData) throws FCPluginException

Schnittstelle IPluginDefaultLifecycleData

Die Schnittstelle stellt folgende Methoden zur Verfügung:

getScopeKey()
Liefert Informationen zum Scope in welchem das Plugin installiert wurde. (Die UUID des Mandanten, wenn im Mandant-Scope registriert, sonst "system" wenn Plugin im System-Scope registriert wurde.)
getRuntimeKey()
Liefert die UUID, unter welcher das Plugin in der Datenbank abgespeichert wurde.
getClient()
Liefert das aktuelle Mandant-Objekt zurück, oder null, wenn Plugin nicht im Scope eines Mandanten registriert wurde.
getProperties()
Ermöglicht den Zugriff auf die am Plugin-Bundle hinterlegten Properties.
getFileHelper()
Liefert ein Hilfs-Objekt zur Unterstützung der Arbeit mit Plugin-Dateien.
getResourceHelper()
Liefert ein Hilfs-Objekt zur Arbeit mit den sprachspezifischen Ressourcen.
getFrontendServer()
Liefert den Frontend-Server wo das Plugin installiert ist, oder null, wenn es auf dem Master-Server installiert wurde.