org.openlowcode.server.action

Class ActionExecution

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.server.action.ActionExecution

All Implemented Interfaces:

NamedInterface

Direct Known Subclasses:

org.openlowcode.module.system.action.generated.AbsAccepttaskAction, org.openlowcode.module.system.action.generated.AbsActivetaskcomplexqueryAction, org.openlowcode.module.system.action.generated.AbsAddlogsAction, org.openlowcode.module.system.action.generated.AbsAudittextAction, org.openlowcode.module.system.action.generated.AbsCanaccepttaskAction, org.openlowcode.module.system.action.generated.AbsCanrejecttaskAction, org.openlowcode.module.system.action.generated.AbsChangepasswordAction, org.openlowcode.module.system.action.generated.AbsCleanpendingemailsAction, org.openlowcode.module.system.action.generated.AbsClosesessionAction, org.openlowcode.module.system.action.generated.AbsCompletetaskAction, org.openlowcode.module.system.action.generated.AbsCopyuserstogroupAction, org.openlowcode.module.system.action.generated.AbsCreatesessionforuserAction, org.openlowcode.module.system.action.generated.AbsCreateuserfromldapAction, org.openlowcode.module.system.action.generated.AbsDisplaygenericobjectAction, org.openlowcode.module.system.action.generated.AbsGeneratefaultymessageAction, org.openlowcode.module.system.action.generated.AbsGetdomainhierarchyAction, org.openlowcode.module.system.action.generated.AbsGetfileAction, org.openlowcode.module.system.action.generated.AbsGetfrontpagedataAction, org.openlowcode.module.system.action.generated.AbsGetsessionforclientAction, org.openlowcode.module.system.action.generated.AbsLaunchaddlogsAction, org.openlowcode.module.system.action.generated.AbsLaunchadduserAction, org.openlowcode.module.system.action.generated.AbsLaunchchangepasswordAction, org.openlowcode.module.system.action.generated.AbsLaunchcleanpendingemailsAction, org.openlowcode.module.system.action.generated.AbsLaunchsessioncleaningAction, org.openlowcode.module.system.action.generated.AbsLaunchtechnicaltoolsAction, org.openlowcode.module.system.action.generated.AbsLoginAction, org.openlowcode.module.system.action.generated.AbsModuleusagesummaryAction, org.openlowcode.module.system.action.generated.AbsPreparecopyuserstogroupAction, org.openlowcode.module.system.action.generated.AbsQueryforuserAction, org.openlowcode.module.system.action.generated.AbsReassigntaskAction, org.openlowcode.module.system.action.generated.AbsRejecttaskAction, org.openlowcode.module.system.action.generated.AbsResetextralogsAction, org.openlowcode.module.system.action.generated.AbsSavetaskcommentAction, org.openlowcode.module.system.action.generated.AbsSeeprivilegesAction, org.openlowcode.module.system.action.generated.AbsSessioncleaningAction, org.openlowcode.module.system.action.generated.AbsShowactivetaskAction, org.openlowcode.module.system.action.generated.AbsShowcurrentuserAction, org.openlowcode.module.system.action.generated.AbsShowmodulestatAction, org.openlowcode.module.system.action.generated.AbsShowuserstatAction, org.openlowcode.module.system.action.generated.AbsSpecificmoduleusagesummaryAction

public abstract class ActionExecution
extends Named

An ActionExecution class actually executes a request for an action coming from a customer. For each action execution, a new instance of a class is created. Actions

• should not use any static attribute during execution as different threads may mix-up
• the Open Lowcode design studio will generate abstract action classes that should be implemented by the user. No direct subclass of this clas should be implemented directly by a developer

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
ActionExecution(java.lang.String name, SModule parent) creates a new action execution

Method Summary

Modifier and Type	Method and Description
abstract SPage	executeActionFromGUI(SActionData actionattributes) The action is executed, and its result is shown in a page on the client
abstract SPage	executeActionFromGUI(SActionData actionattributes, java.util.function.Function<TableAlias,QueryFilter> datafilter) The action is executed, and its result is shown in a page on the client, with a specified filter for data specified
abstract SPageData	executeInlineAction(SActionData actiondata) executes the action as an inline action (enriching a page currently displayed on the client
abstract SPageData	executeInlineAction(SActionData actiondata, java.util.function.Function<TableAlias,QueryFilter> datafilter) executes the action as an inline action (enriching a page currently displayed on the client) with a query filter
void	freezeUnauthorizedObjects(DataObject<?>[] dataarray) will check according to action manager and freeze objects that are not modified
protected static <T extends DataEltType> SActionInputDataRef<T>	getActionInputDataRef(java.lang.String name, T type, int order) generates an ActionInputDataRef for the action
protected static <T extends DataEltType> SActionOutputDataRef<T>	getActionOutputDataRef(java.lang.String name, T type, int order) generates a reference to an output attribute
protected SActionRef	getActionReference() this creates an action reference that can be linked to a widget in order to display a new page
abstract ActionSecurityManager[]	getActionSecurityManager() this function is called by the server security manager to get the security manager for the action
protected SInlineActionRef	getInlineActionReference() this creates an inline action reference that can be linked to a widget in order to launch an action to launch the page
protected abstract int	getInputSecurityArgumentIndex()
java.lang.String	getMessage()
protected static <T extends DataEltType> SNullActionInputDataRef<T>	getNullActionInputDataRef(java.lang.String name, T type, int order) generates a null action input data ref for the
SModule	getParent()
boolean	isPopup()
void	setMessage(java.lang.String message) sets the message to show in title
void	setPopup(boolean popup)

Methods inherited from class org.openlowcode.tools.misc.Named

changeName, cleanName, equals, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionExecution

public ActionExecution(java.lang.String name,
                       SModule parent)

creates a new action execution

Parameters:

name - unique name of the action for the parent module

parent - parent module

Method Detail

getMessage

public java.lang.String getMessage()

Returns:

the message to show in title

setMessage

public void setMessage(java.lang.String message)

sets the message to show in title

Parameters:

message - the message to show in title

isPopup

public boolean isPopup()

Returns:

true if the action is triggered from a popup on the client screen

setPopup

public void setPopup(boolean popup)

Parameters:

popup - if the action is triggered from a popup on the client screen

getParent

public SModule getParent()

Returns:

the parent module

getInputSecurityArgumentIndex

protected abstract int getInputSecurityArgumentIndex()

Returns:

-1 if there is no input security argument, the index of the security argument (0 or higher)

getInlineActionReference

protected SInlineActionRef getInlineActionReference()

this creates an inline action reference that can be linked to a widget in order to launch an action to launch the page

Returns:

the inline action reference

getActionReference

protected SActionRef getActionReference()

this creates an action reference that can be linked to a widget in order to display a new page

Returns:

the action reference

freezeUnauthorizedObjects

public void freezeUnauthorizedObjects(DataObject<?>[] dataarray)

will check according to action manager and freeze objects that are not modified

Parameters:

dataarray - the array of objects to check

executeActionFromGUI

public abstract SPage executeActionFromGUI(SActionData actionattributes)

The action is executed, and its result is shown in a page on the client

Parameters:

actionattributes - the list of attributes

Returns:

the page displayed

executeActionFromGUI

public abstract SPage executeActionFromGUI(SActionData actionattributes,
                                           java.util.function.Function<TableAlias,QueryFilter> datafilter)

The action is executed, and its result is shown in a page on the client, with a specified filter for data specified

Parameters:

actionattributes -

datafilter -

Returns:

getActionInputDataRef

protected static <T extends DataEltType> SActionInputDataRef<T> getActionInputDataRef(java.lang.String name,
                                                                                      T type,
                                                                                      int order)

generates an ActionInputDataRef for the action

Parameters:

name - name of the data reference

type - type of the data reference

order - order of the attribute

Returns:

the generated ActionInputDataRef

getNullActionInputDataRef

protected static <T extends DataEltType> SNullActionInputDataRef<T> getNullActionInputDataRef(java.lang.String name,
                                                                                              T type,
                                                                                              int order)

generates a null action input data ref for the

Parameters:

name - name of the attribute

type - type type of the attribute

order - order of the attribute

Returns:

a null action input data ref

getActionOutputDataRef

protected static <T extends DataEltType> SActionOutputDataRef<T> getActionOutputDataRef(java.lang.String name,
                                                                                        T type,
                                                                                        int order)

generates a reference to an output attribute

Parameters:

name - name of the attribute

type - type type of the attribute

order - order of the attribute

Returns:

the generate output attribute

executeInlineAction

public abstract SPageData executeInlineAction(SActionData actiondata)

executes the action as an inline action (enriching a page currently displayed on the client

Parameters:

actiondata - inputaction data

Returns:

output action data

executeInlineAction

public abstract SPageData executeInlineAction(SActionData actiondata,
                                              java.util.function.Function<TableAlias,QueryFilter> datafilter)

executes the action as an inline action (enriching a page currently displayed on the client) with a query filter

Parameters:

actiondata - action input data

datafilter - data filter

Returns:

output action data

getActionSecurityManager

public abstract ActionSecurityManager[] getActionSecurityManager()

this function is called by the server security manager to get the security manager for the action

Returns:

the security managers for the action, or null if the action has no security manager