de.ipcon.gui

Class ClientStructureExecutionHelper

java.lang.Object

de.ipcon.gui.AbstractClientHelper

de.ipcon.gui.ClientStructureExecutionHelper

public class ClientStructureExecutionHelper
extends AbstractClientHelper

Coordinates execution workflows for structure elements.

Constructor Summary

Constructors

Constructor and Description
ClientStructureExecutionHelper(Client _client)

Method Summary

Modifier and Type	Method and Description
Lesezeichen	getBookmarkByTid(java.lang.String tid, java.lang.String entityName) Retrieves a single Lesezeichen uniquely identified by its tid and entity name.
Lesezeichen[]	getBookmarks(EntityI entity, boolean reload) Returns all Lesezeichen instances associated with the specified entity, sorted by priority in descending order (highest priority first).
Formular	getFormByTid(java.lang.String tid, java.lang.String entityName) Retrieves a single Formular uniquely identified by its tid and entity name.
Formular[]	getForms(EntityI entity, boolean reload) Returns all Formular instances associated with the specified entity, sorted by priority in descending order (highest priority first).
Report	getReportByTid(java.lang.String tid, java.lang.String entityName) Retrieves a single Report uniquely identified by its tid and entity name.
Report[]	getReports(EntityI entity, boolean reload) Returns all Report instances associated with the specified entity, sorted by priority in descending order (highest priority first).
Struktur[]	getStrukturenForEntity(java.lang.String entityName, boolean reload, boolean directOnly, EntityI[] entitiesOnly) Returns all structures for a given entity-name
Struktur[]	getStrukturenForSearchString(java.lang.String searchString, int searchType, boolean reload, boolean directOnly, EntityI[] entitiesOnly) Searches entities for a given string and generates/retrieves the structures for them
Schablone	getTemplateByTid(java.lang.String tid, java.lang.String entityName) Retrieves a single Schablone uniquely identified by its tid and entity name.
Schablone[]	getTemplates(EntityI entity, boolean reload) Returns all Schablone instances associated with the specified entity, sorted by priority in descending order (highest priority first).
Schablone[]	getTemplatesForSubEntitiesInAdminsOrdner(EntityI entity, boolean reload, boolean uniqueEntities, java.util.Set entitiesToExclude) Internal specialized lookup for templates across polymorphic sub-entities located in administrator folders.
FormElementI	openForm(Formular form, BO bo)
FormElementI	openForm(Formular form, BO bo, java.util.Map parameters)
FormElementI	openForm(Formular form, BO bo, java.util.Map parameters, FormElementI origin)
FormElementI	openForm(Formular form, BO bo, java.util.Map parameters, java.lang.String title)
FormElementI	openForm(Formular form, BO bo, java.util.Map parameters, java.lang.String title, FormContextI ftx)
FormElementI	openForm(Formular form, BO bo, java.util.Map parameters, java.lang.String title, FormContextI ftx, boolean massChange)
FormElementI	openForm(Formular form, BO bo, java.util.Map parameters, java.lang.String title, FormContextI ftx, boolean massChange, int viewType)
FormElementI	openForm(Formular form, BO bo, java.util.Map parameters, java.lang.String title, FormContextI ftx, boolean massChange, int viewType, java.awt.Rectangle forcedBounds)
FormElementI	openForm(Formular form, BO bo, java.util.Map parameters, java.lang.String title, FormContextI ftx, boolean massChange, int viewType, java.awt.Rectangle forcedBounds, boolean maximize)
FormElementI	openForm(Formular form, BO bo, java.util.Map parameters, java.lang.String title, FormContextI ftx, boolean massChange, int viewType, java.awt.Rectangle forcedBounds, boolean maximize, boolean ignoreOpenInstance)
FormElementI	openForm(Formular form, BO bo, java.util.Map parameters, java.lang.String title, FormContextI ftx, boolean massChange, int viewType, java.awt.Rectangle forcedBounds, boolean maximize, boolean ignoreOpenInstance, boolean reuseOpenIfNew)
FormElementI	openForm(Formular form, BO bo, java.util.Map parameters, java.lang.String title, FormContextI ftx, boolean massChange, int viewType, java.awt.Rectangle forcedBounds, boolean maximize, boolean ignoreOpenInstance, boolean reuseOpenIfNew, boolean skipTxLoadedNewBOs) Opens a form without an explicit Transaction context.
FormElementI	openForm(Formular form, Transaction tx, BO bo)
FormElementI	openForm(Formular form, Transaction tx, BO bo, java.util.Map parameters)
FormElementI	openForm(Formular form, Transaction tx, BO bo, java.util.Map parameters, java.lang.String title)
FormElementI	openForm(Formular form, Transaction tx, BO bo, java.util.Map parameters, java.lang.String title, FormContextI ftx)
FormElementI	openForm(Formular form, Transaction tx, BO bo, java.util.Map parameters, java.lang.String title, FormContextI ftx, boolean massChange)
FormElementI	openForm(Formular form, Transaction tx, BO bo, java.util.Map parameters, java.lang.String title, FormContextI ftx, boolean massChange, int viewType)
FormElementI	openForm(Formular form, Transaction tx, BO bo, java.util.Map parameters, java.lang.String title, FormContextI ftx, boolean massChange, int viewType, java.awt.Rectangle forcedBounds)
FormElementI	openForm(Formular form, Transaction tx, BO bo, java.util.Map parameters, java.lang.String title, FormContextI ftx, boolean massChange, int viewType, java.awt.Rectangle forcedBounds, boolean maximize)
FormElementI	openForm(Formular form, Transaction tx, BO bo, java.util.Map parameters, java.lang.String title, FormContextI ftx, boolean massChange, int viewType, java.awt.Rectangle forcedBounds, boolean maximize, boolean ignoreOpenInstance)
FormElementI	openForm(Formular form, Transaction tx, BO bo, java.util.Map parameters, java.lang.String title, FormContextI ftx, boolean massChange, int viewType, java.awt.Rectangle forcedBounds, boolean maximize, boolean ignoreOpenInstance, boolean reuseOpenIfNew)
FormElementI	openForm(Formular form, Transaction tx, BO bo, java.util.Map parameters, java.lang.String title, FormContextI ftx, boolean massChange, int viewType, java.awt.Rectangle forcedBounds, boolean maximize, boolean ignoreOpenInstance, boolean reuseOpenIfNew, boolean skipTxLoadedNewBOs)
FormElementI	openForm(Formular form, Transaction tx, BO bo, java.util.Map parameters, java.lang.String title, FormContextI ftx, boolean massChange, int viewType, java.awt.Rectangle forcedBounds, boolean maximize, boolean ignoreOpenInstance, boolean reuseOpenIfNew, boolean skipTxLoadedNewBOs, FormElementI origin) Opens a form bound to the specified Transaction, dispatching synchronously to the EDT.
FormElementI	openNew(Schablone s)
FormElementI	openNew(Schablone s, java.util.Map parameters)
FormElementI	openNew(Schablone s, java.util.Map parameters, FormElementI origin)
FormElementI	openView(BO bo)
FormElementI	openView(BO bo, java.util.Map parameters)
FormElementI	openView(BO bo, java.util.Map parameters, java.lang.String title)
FormElementI	openView(BO bo, java.util.Map parameters, java.lang.String title, boolean reloadFormList)
FormElementI	openView(BO bo, java.util.Map parameters, java.lang.String title, boolean reloadFormList, boolean useAutomatic)
FormElementI	openView(Lesezeichen l)
FormElementI	openView(Lesezeichen l, java.util.Map parameters)
FormElementI	reopenView(FormElementI fe, Struktur useStruktur, boolean _reloadBO)

Methods inherited from class de.ipcon.gui.AbstractClientHelper

client

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientStructureExecutionHelper

public ClientStructureExecutionHelper(Client _client)

Method Detail

openNew

public FormElementI openNew(Schablone s)

openNew

public FormElementI openNew(Schablone s,
                            java.util.Map parameters)

openNew

public FormElementI openNew(Schablone s,
                            java.util.Map parameters,
                            FormElementI origin)

openForm

public FormElementI openForm(Formular form,
                             BO bo,
                             java.util.Map parameters,
                             FormElementI origin)

openForm

public FormElementI openForm(Formular form,
                             BO bo)

openForm

public FormElementI openForm(Formular form,
                             BO bo,
                             java.util.Map parameters)

openForm

public FormElementI openForm(Formular form,
                             BO bo,
                             java.util.Map parameters,
                             java.lang.String title)

openForm

public FormElementI openForm(Formular form,
                             BO bo,
                             java.util.Map parameters,
                             java.lang.String title,
                             FormContextI ftx)

openForm

public FormElementI openForm(Formular form,
                             BO bo,
                             java.util.Map parameters,
                             java.lang.String title,
                             FormContextI ftx,
                             boolean massChange)

openForm

public FormElementI openForm(Formular form,
                             BO bo,
                             java.util.Map parameters,
                             java.lang.String title,
                             FormContextI ftx,
                             boolean massChange,
                             int viewType)

openForm

public FormElementI openForm(Formular form,
                             BO bo,
                             java.util.Map parameters,
                             java.lang.String title,
                             FormContextI ftx,
                             boolean massChange,
                             int viewType,
                             java.awt.Rectangle forcedBounds)

openForm

public FormElementI openForm(Formular form,
                             BO bo,
                             java.util.Map parameters,
                             java.lang.String title,
                             FormContextI ftx,
                             boolean massChange,
                             int viewType,
                             java.awt.Rectangle forcedBounds,
                             boolean maximize)

openForm

public FormElementI openForm(Formular form,
                             BO bo,
                             java.util.Map parameters,
                             java.lang.String title,
                             FormContextI ftx,
                             boolean massChange,
                             int viewType,
                             java.awt.Rectangle forcedBounds,
                             boolean maximize,
                             boolean ignoreOpenInstance)

openForm

public FormElementI openForm(Formular form,
                             BO bo,
                             java.util.Map parameters,
                             java.lang.String title,
                             FormContextI ftx,
                             boolean massChange,
                             int viewType,
                             java.awt.Rectangle forcedBounds,
                             boolean maximize,
                             boolean ignoreOpenInstance,
                             boolean reuseOpenIfNew)

openForm

public FormElementI openForm(Formular form,
                             BO bo,
                             java.util.Map parameters,
                             java.lang.String title,
                             FormContextI ftx,
                             boolean massChange,
                             int viewType,
                             java.awt.Rectangle forcedBounds,
                             boolean maximize,
                             boolean ignoreOpenInstance,
                             boolean reuseOpenIfNew,
                             boolean skipTxLoadedNewBOs)

Opens a form without an explicit Transaction context.

Parameters:

form - the form definition to display

bo - the business object to bind to the form

parameters - optional parameter map passed to the form instance

title - custom window title, or null to use the form's default

ftx - custom form context, or null for default resolution

massChange - true if opened in batch/mass-edit mode; false otherwise

viewType - explicit desktop view mode (defaults to MDIManagerI.VIEWTYPE_FORMULAR)

forcedBounds - explicit initial screen bounds, or null for default positioning

maximize - true to open the window maximized; false for standard bounds

ignoreOpenInstance - true to force a new window even if an instance for this BO is already open

reuseOpenIfNew - true to allow reusing an open window even when the BO is newly created

skipTxLoadedNewBOs - true to prevent auto-including/frapping newly created BOs loaded by the form's transaction

Returns:

the created or focused form element instance

openForm

public FormElementI openForm(Formular form,
                             Transaction tx,
                             BO bo)

openForm

public FormElementI openForm(Formular form,
                             Transaction tx,
                             BO bo,
                             java.util.Map parameters)

openForm

public FormElementI openForm(Formular form,
                             Transaction tx,
                             BO bo,
                             java.util.Map parameters,
                             java.lang.String title)

openForm

public FormElementI openForm(Formular form,
                             Transaction tx,
                             BO bo,
                             java.util.Map parameters,
                             java.lang.String title,
                             FormContextI ftx)

openForm

public FormElementI openForm(Formular form,
                             Transaction tx,
                             BO bo,
                             java.util.Map parameters,
                             java.lang.String title,
                             FormContextI ftx,
                             boolean massChange)

openForm

public FormElementI openForm(Formular form,
                             Transaction tx,
                             BO bo,
                             java.util.Map parameters,
                             java.lang.String title,
                             FormContextI ftx,
                             boolean massChange,
                             int viewType)

openForm

public FormElementI openForm(Formular form,
                             Transaction tx,
                             BO bo,
                             java.util.Map parameters,
                             java.lang.String title,
                             FormContextI ftx,
                             boolean massChange,
                             int viewType,
                             java.awt.Rectangle forcedBounds)

openForm

public FormElementI openForm(Formular form,
                             Transaction tx,
                             BO bo,
                             java.util.Map parameters,
                             java.lang.String title,
                             FormContextI ftx,
                             boolean massChange,
                             int viewType,
                             java.awt.Rectangle forcedBounds,
                             boolean maximize)

openForm

public FormElementI openForm(Formular form,
                             Transaction tx,
                             BO bo,
                             java.util.Map parameters,
                             java.lang.String title,
                             FormContextI ftx,
                             boolean massChange,
                             int viewType,
                             java.awt.Rectangle forcedBounds,
                             boolean maximize,
                             boolean ignoreOpenInstance)

openForm

public FormElementI openForm(Formular form,
                             Transaction tx,
                             BO bo,
                             java.util.Map parameters,
                             java.lang.String title,
                             FormContextI ftx,
                             boolean massChange,
                             int viewType,
                             java.awt.Rectangle forcedBounds,
                             boolean maximize,
                             boolean ignoreOpenInstance,
                             boolean reuseOpenIfNew)

openForm

public FormElementI openForm(Formular form,
                             Transaction tx,
                             BO bo,
                             java.util.Map parameters,
                             java.lang.String title,
                             FormContextI ftx,
                             boolean massChange,
                             int viewType,
                             java.awt.Rectangle forcedBounds,
                             boolean maximize,
                             boolean ignoreOpenInstance,
                             boolean reuseOpenIfNew,
                             boolean skipTxLoadedNewBOs)

openForm

public FormElementI openForm(Formular form,
                             Transaction tx,
                             BO bo,
                             java.util.Map parameters,
                             java.lang.String title,
                             FormContextI ftx,
                             boolean massChange,
                             int viewType,
                             java.awt.Rectangle forcedBounds,
                             boolean maximize,
                             boolean ignoreOpenInstance,
                             boolean reuseOpenIfNew,
                             boolean skipTxLoadedNewBOs,
                             FormElementI origin)

Opens a form bound to the specified Transaction, dispatching synchronously to the EDT.

Parameters:

form - the form definition to display

tx - the transaction managing the lifecycle and persistence of the BO

bo - the business object to bind to the form

parameters - optional parameter map passed to the form instance

title - custom window title, or null to use the form's default

ftx - custom form context, or null for default resolution

massChange - true if opened in batch/mass-edit mode; false otherwise

viewType - explicit desktop view mode (defaults to MDIManagerI.VIEWTYPE_FORMULAR)

forcedBounds - explicit initial screen bounds, or null for default positioning

maximize - true to open the window maximized; false for standard bounds

ignoreOpenInstance - true to force a new window even if an instance for this BO is already open

reuseOpenIfNew - true to allow reusing an open window even when the BO is newly created

skipTxLoadedNewBOs - true to prevent auto-including/frapping newly created BOs loaded by the form's transaction

origin - the initiating UI component, or null

Returns:

the created or focused form element instance

openView

public FormElementI openView(Lesezeichen l)

openView

public FormElementI openView(Lesezeichen l,
                             java.util.Map parameters)

openView

public FormElementI openView(BO bo)

openView

public FormElementI openView(BO bo,
                             java.util.Map parameters)

openView

public FormElementI openView(BO bo,
                             java.util.Map parameters,
                             java.lang.String title)

openView

public FormElementI openView(BO bo,
                             java.util.Map parameters,
                             java.lang.String title,
                             boolean reloadFormList)

openView

public FormElementI openView(BO bo,
                             java.util.Map parameters,
                             java.lang.String title,
                             boolean reloadFormList,
                             boolean useAutomatic)

reopenView

public FormElementI reopenView(FormElementI fe,
                               Struktur useStruktur,
                               boolean _reloadBO)

getStrukturenForSearchString

public Struktur[] getStrukturenForSearchString(java.lang.String searchString,
                                               int searchType,
                                               boolean reload,
                                               boolean directOnly,
                                               EntityI[] entitiesOnly)

Searches entities for a given string and generates/retrieves the structures for them

Parameters:

searchString - the String to which the entities are compared

searchType - defines the type of matching done. see DynamischerOrdner

reload - force a reload

directOnly - only return structure that is for the entity directly, that is resolved from the path, no parent class structure

entitiesOnly - only returns structure of the passed EntityI; no restriction if null

getStrukturenForEntity

public Struktur[] getStrukturenForEntity(java.lang.String entityName,
                                         boolean reload,
                                         boolean directOnly,
                                         EntityI[] entitiesOnly)

Returns all structures for a given entity-name

Parameters:

entity - The entity name for which to collect the structures

reload - force a reload

directOnly - only return structures that are for the entity directly, no parent class structures

entitiesOnly - only adds structures of the passed EntityI; no restriction if null

getTemplates

public Schablone[] getTemplates(EntityI entity,
                                boolean reload)

Returns all Schablone instances associated with the specified entity, sorted by priority in descending order (highest priority first). Only templates assigned to at least one group of the current user are returned.

Parameters:

entity - the target entity for which to retrieve templates

reload - if true, forces a fresh database query; if false, cached instances from the StrukturCache may be used

Returns:

an array of matching Schablone instances, or an empty array if none are found

Throws:

MissingArgumentException - if entity is null

getTemplatesForSubEntitiesInAdminsOrdner

public Schablone[] getTemplatesForSubEntitiesInAdminsOrdner(EntityI entity,
                                                            boolean reload,
                                                            boolean uniqueEntities,
                                                            java.util.Set entitiesToExclude)

Internal specialized lookup for templates across polymorphic sub-entities located in administrator folders. Intended primarily for our UI tree component (i.e. PolymorphicTemplateSelectionTree).

Parameters:

entity - the parent entity defining the polymorphic subtree scope

reload - if true, forces a fresh database query bypass of the cache

uniqueEntities - if true, restricts the output to at most one template per sub-entity type

entitiesToExclude - optional set of EntityI instances to skip during traversal; may be null

Returns:

an array of sub-entity Schablone instances assigned to the current user's groups

Throws:

MissingArgumentException - if entity is null

getForms

public Formular[] getForms(EntityI entity,
                           boolean reload)

Returns all Formular instances associated with the specified entity, sorted by priority in descending order (highest priority first). Only forms assigned to at least one group of the current user are returned.

Parameters:

entity - the target entity for which to retrieve forms

reload - if true, forces a fresh database query; if false, cached instances from the StrukturCache may be used

Returns:

an array of matching Formular instances, or an empty array if none are found

Throws:

MissingArgumentException - if entity is null

getBookmarks

public Lesezeichen[] getBookmarks(EntityI entity,
                                  boolean reload)

Returns all Lesezeichen instances associated with the specified entity, sorted by priority in descending order (highest priority first). Only bookmarks assigned to at least one group of the current user are returned.

Parameters:

entity - the target entity for which to retrieve bookmarks

reload - if true, forces a fresh database query; if false, cached instances from the StrukturCache may be used

Returns:

an array of matching Lesezeichen instances, or an empty array if none are found

Throws:

MissingArgumentException - if entity is null

getReports

public Report[] getReports(EntityI entity,
                           boolean reload)

Returns all Report instances associated with the specified entity, sorted by priority in descending order (highest priority first). Only reports assigned to at least one group of the current user are returned.

Parameters:

entity - the target entity for which to retrieve reports

reload - if true, forces a fresh database query; if false, cached instances from the StrukturCache may be used

Returns:

an array of matching Report instances, or an empty array if none are found

Throws:

MissingArgumentException - if entity is null

getTemplateByTid

public Schablone getTemplateByTid(java.lang.String tid,
                                  java.lang.String entityName)

Retrieves a single Schablone uniquely identified by its tid and entity name. Only templates assigned to at least one group of the current user are returned.

Parameters:

tid - the tid of the template

entityName - the simple name of the target entity

Returns:

the matching Schablone, or null if no template matches or if no matching template is assigned to at least one group of the current user; if multiple templates match, the one with the highest priority is returned

Throws:

EntityResolveException - if entityName is null or cannot be resolved to a valid entity

getFormByTid

public Formular getFormByTid(java.lang.String tid,
                             java.lang.String entityName)

Retrieves a single Formular uniquely identified by its tid and entity name. Only forms assigned to at least one group of the current user are returned.

Parameters:

tid - the tid of the form

entityName - the simple name of the target entity

Returns:

the matching Formular, or null if no form matches or if no matching form is assigned to at least one group of the current user; if multiple forms match, the one with the highest priority is returned

Throws:

EntityResolveException - if entityName is null or cannot be resolved to a valid entity

getBookmarkByTid

public Lesezeichen getBookmarkByTid(java.lang.String tid,
                                    java.lang.String entityName)

Retrieves a single Lesezeichen uniquely identified by its tid and entity name. Only bookmarks assigned to at least one group of the current user are returned.

Parameters:

tid - the tid of the bookmark

entityName - the simple name of the target entity

Returns:

the matching Lesezeichen, or null if no bookmark matches or if no matching bookmark is assigned to at least one group of the current user; if multiple bookmarks match, the one with the highest priority is returned

Throws:

EntityResolveException - if entityName is null or cannot be resolved to a valid entity

getReportByTid

public Report getReportByTid(java.lang.String tid,
                             java.lang.String entityName)

Retrieves a single Report uniquely identified by its tid and entity name. Only reports assigned to at least one group of the current user are returned.

Parameters:

tid - the tid of the report

entityName - the simple name of the target entity

Returns:

the matching Report, or null if no report matches or if no matching report is assigned to at least one group of the current user; if multiple reports match, the one with the highest priority is returned

Throws:

EntityResolveException - if entityName is null or cannot be resolved to a valid entity