Package de.xima.fc.handler.interfaces.system

Interface ISetupHandler

All Superinterfaces:

IAPIHandler, Serializable

All Known Implementing Classes:

SetupHandler

public interface ISetupHandler
extends IAPIHandler

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
boolean	createManantWithDependencies(UserContext uc, Mandant client, MandantMailData clientMailData, MandantLdapData clientLdapData, Benutzer user)	Deprecated. Use createManantWithDependencies(UserContext, Mandant, MandantMailData, String, IUser) instead.
boolean	createManantWithDependencies(UserContext uc, Mandant client, MandantMailData clientMailData, String adminEmail, IUser creator)	Methode zum Anlegen eines Mandanten mit der initialen Konfiguration, analog zum Setup-Prozess
List<XLogAppender>	getAvailableLogAppenders()	Deprecated.
FCMessage	invokeLiquibaseProzess(UserContext uc, ELiquibaseCmd lbCmd)	Deprecated. Use FormcycleUpdate instead.
Boolean	isDbConfigured(UserContext uc)	Methode zum Testen ob die Datenbank konfigureiert wurde
Boolean	isDbRunning()	Checks whether the database is running or not
Boolean	isDbUpToDate()	Checks whether the database is up to date
Boolean	isUpdateNeeded()	Checks whether there are updated that have not been executed yet.
Boolean	testConnection(UserContext uc, DBConnectionData db)	Test connection.

Methods inherited from interface de.xima.fc.com.interfaces.IAPIHandler

getName

Method Detail

invokeLiquibaseProzess

@Deprecated
FCMessage invokeLiquibaseProzess(UserContext uc,
                                 ELiquibaseCmd lbCmd)

Deprecated.

Use FormcycleUpdate instead.

Invoke liquibase prozess.

Parameters:

uc - the UserContext to use

lbCmd - the lb cmd

Returns:

FCMessage with errors or info messages

testConnection

Boolean testConnection(UserContext uc,
                       DBConnectionData db)

Test connection.

Parameters:

db - the db

Returns:

true wenn die Verbindung hergestellt werden konnte @

isDbConfigured

Boolean isDbConfigured(UserContext uc)

Methode zum Testen ob die Datenbank konfigureiert wurde

Returns:

Boolean true wenn die Datenbank bereits konfiguriert ist, sonst false

isDbUpToDate

Boolean isDbUpToDate()

Checks whether the database is up to date

Returns:

Boolean whether the database is up to date or not

isDbRunning

Boolean isDbRunning()

Checks whether the database is running or not

Returns:

Boolean whether the database is running or not

isUpdateNeeded

Boolean isUpdateNeeded()

Checks whether there are updated that have not been executed yet.

Returns:

Boolean whether there are unperformed updates.

createManantWithDependencies

boolean createManantWithDependencies(UserContext uc,
                                     Mandant client,
                                     MandantMailData clientMailData,
                                     String adminEmail,
                                     IUser creator)

Methode zum Anlegen eines Mandanten mit der initialen Konfiguration, analog zum Setup-Prozess

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

client - the client

clientMailData - the mail data of the client

adminEmail - email address of the new client admin

creator - the user that is creating the client

Returns:

true wenn der Mandant samt der initialen Konfiguration erfolgreich angelegt werden konnte. @ Fehler beim Anlegen

Since:

8.0.0

getAvailableLogAppenders

@Deprecated
List<XLogAppender> getAvailableLogAppenders()

Deprecated.

createManantWithDependencies

@Deprecated
boolean createManantWithDependencies(UserContext uc,
                                     Mandant client,
                                     MandantMailData clientMailData,
                                     MandantLdapData clientLdapData,
                                     Benutzer user)

Deprecated.

Use createManantWithDependencies(UserContext, Mandant, MandantMailData, String, IUser) instead. Methode zum Anlegen eines Mandanten mit der initialen Konfiguration, analog zum Setup-Prozess

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

client - the client

clientMailData - the mail data of the client

clientLdapData - the LDAP data of the client

user - the initial user to create

Returns:

true wenn der Mandant samt der initialen Konfiguration erfolgreich angelegt werden konnte. @ Fehler beim Anlegen