Package de.xima.fc.gui.designer.form.utils

Class FormDesignerEnvironmentData

java.lang.Object

de.xima.fc.gui.designer.form.utils.FormDesignerEnvironmentData

All Implemented Interfaces:

IFormDesignerEnvironmentData, IBaseEnvironmentData

public final class FormDesignerEnvironmentData
extends Object
implements IFormDesignerEnvironmentData

A new POJO for IFormDesignerEnvironmentData.

Since:

8.0.0

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
FormDesignerEnvironmentData(IEntityContext entityContext, Mandant client, IUser user, Locale locale, Projekt project, FormVersion formVersion, WorkflowVersion workflowVersion)

Method Summary

Modifier and Type	Method	Description
Mandant	getClient()
IEntityContext	getEntityContext()
FormVersion	getFormVersion()
Locale	getLocale()
Projekt	getProject()
IUser	getUserModel()
WorkflowVersion	getWorkflowVersion()

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IBaseEnvironmentData

getUser

Constructor Detail

FormDesignerEnvironmentData

public FormDesignerEnvironmentData(IEntityContext entityContext,
                                   Mandant client,
                                   IUser user,
                                   Locale locale,
                                   Projekt project,
                                   FormVersion formVersion,
                                   WorkflowVersion workflowVersion)

Parameters:

entityContext - Value for IBaseEnvironmentData.getEntityContext()

client - Value for IBaseEnvironmentData.getClient()

user - Value for IBaseEnvironmentData.getUser()

locale - Value for IBaseEnvironmentData.getLocale()

project - Value for IFormDesignerEnvironmentData.getProject()

formVersion - Value for IFormDesignerEnvironmentData.getFormVersion()

workflowVersion - Value for IFormDesignerEnvironmentData.getWorkflowVersion()

Method Detail

getClient

public Mandant getClient()

Specified by:

getClient in interface IBaseEnvironmentData

Returns:

The Mandant of the current context.

getEntityContext

public IEntityContext getEntityContext()

Specified by:

getEntityContext in interface IBaseEnvironmentData

Returns:

The current entity context that may be used for database interactions.

getFormVersion

public FormVersion getFormVersion()

Specified by:

getFormVersion in interface IFormDesignerEnvironmentData

Returns:

The form version of the project that is currently opened in the form designer.

getLocale

public Locale getLocale()

Specified by:

getLocale in interface IBaseEnvironmentData

Returns:

The locale to use for locale-sensitive actions.

getProject

public Projekt getProject()

Specified by:

getProject in interface IFormDesignerEnvironmentData

Returns:

The project that is currently opened in the form designer.

getUserModel

public IUser getUserModel()

Specified by:

getUserModel in interface IBaseEnvironmentData

Returns:

The user of the active context that should be used for protocol entries etc.

getWorkflowVersion

public WorkflowVersion getWorkflowVersion()

Specified by:

getWorkflowVersion in interface IFormDesignerEnvironmentData

Returns:

The form version of the project that is currently opened in the form designer. May be null when the form uses the old workflow.