org.openlowcode.design.action

Class ActionDefinition

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.design.action.ActionDefinition

All Implemented Interfaces:

ActionGroup, NamedInterface

Direct Known Subclasses:

DynamicActionDefinition, StaticActionDefinition

public abstract class ActionDefinition
extends Named
implements ActionGroup

An action is a business transaction that is triggered from user actions on the client. Each action is checked for security. * @author Open Lowcode SAS

Author:

Open Lowcode SAS

Field Summary

Fields

Modifier and Type	Field and Description
protected ArgumentContent	accesscriteria
protected int	accesscriteriaindex
protected boolean	accesscriteriaisinput

Constructor Summary

Constructors

Constructor and Description
ActionDefinition(java.lang.String name) creates a user defined (not autogenerated) action
ActionDefinition(java.lang.String name, boolean autogenerated) creates an action defining if autogenerated or not
ActionDefinition(java.lang.String name, java.lang.String specification) creates an action (user-defined) with a specification to include in the javadoc of the action
ActionDefinition(java.lang.String name, java.lang.String specification, boolean autogenerated) creates an action with a specification to include in the javadoc of the action

Method Summary

Modifier and Type	Method and Description
void	addBusinessRule(java.lang.String businessrule) adds a business rule (in plain text) for the action rules to be added to the action javadoc
void	addOutputArgument(ArgumentContent thisargument) adds an output argument to this action
void	addOutputArgumentAsAccessCriteria(ArgumentContent thisargument) adds this output argument as security criteria.
void	forceNoAddress() This will ensure the function will never have an address for the action.
void	generateToFile(SourceGenerator sg, Module module) generates the abstract class of the action to file.
ArgumentContent	getAccessCriteria()
int	getAccessCriteriaIndex()
ActionDefinition[]	getActionsInGroup()
java.lang.String	getButtonlabel()
abstract NamedList<ArgumentContent>	getInputArguments()
Module	getModule()
ArgumentContent	getOutputArgument(int i) get the output argument at the given index
int	getOutputArgumentNumber()
abstract ObjectArgument	getSecurityobjectargument() this method returns the object argument used for security if it exists
abstract ObjectIdArgument	getSecurityobjectidargument() this method returns the object argument id used for security if it exists
boolean	isAccessCriteriaInput()
boolean	isAddressGenerated(NamedList<ArgumentContent> inputarguments) depending on the arguments, the action can have an address generated that is similar to an URL link.
boolean	isAutogenerated()
void	setButtonlabel(java.lang.String buttonlabel) sets the button label (will be shown when buttons appear in automatic pages for this action)
void	setModule(Module module) sets the parent module
java.lang.String	toString()

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, wait, wait, wait

Methods inherited from interface org.openlowcode.design.access.ActionGroup

getName

Field Detail

accesscriteriaindex

protected int accesscriteriaindex

accesscriteriaisinput

protected boolean accesscriteriaisinput

accesscriteria

protected ArgumentContent accesscriteria

Constructor Detail

ActionDefinition

public ActionDefinition(java.lang.String name)

creates a user defined (not autogenerated) action

Parameters:

name - name of the action, should be unique in the module and a valid java method name (starts by a letter...)

ActionDefinition

public ActionDefinition(java.lang.String name,
                        boolean autogenerated)

creates an action defining if autogenerated or not

Parameters:

name - name of the action, should be unique in the module and a valid java method name (starts by a letter...)

autogenerated - true if autogenerated, false if user generated

ActionDefinition

public ActionDefinition(java.lang.String name,
                        java.lang.String specification)

creates an action (user-defined) with a specification to include in the javadoc of the action

Parameters:

name - name of the action, should be unique in the module and a valid java method name (starts by a letter...)

specification - a free text specification

ActionDefinition

public ActionDefinition(java.lang.String name,
                        java.lang.String specification,
                        boolean autogenerated)

creates an action with a specification to include in the javadoc of the action

Parameters:

name - name of the action, should be unique in the module and a valid java method name (starts by a letter...)

specification - a free text specification

autogenerated - true if autogenerated, false if user generated

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getActionsInGroup

public ActionDefinition[] getActionsInGroup()

Specified by:

getActionsInGroup in interface ActionGroup

Returns:

the list of actions in this group

getModule

public Module getModule()

Returns:

the parent module

getButtonlabel

public java.lang.String getButtonlabel()

Returns:

the button label shown automatically on automatically generated pages. It should be a short description in the default language

getOutputArgumentNumber

public int getOutputArgumentNumber()

Returns:

the number of output arguments

getOutputArgument

public ArgumentContent getOutputArgument(int i)

get the output argument at the given index

Parameters:

i - index between 0 (included) and getOutputArgumentNumber (excluded)

Returns:

setButtonlabel

public void setButtonlabel(java.lang.String buttonlabel)

sets the button label (will be shown when buttons appear in automatic pages for this action)

Parameters:

buttonlabel - button label to use

getAccessCriteriaIndex

public int getAccessCriteriaIndex()

Returns:

get the index of the input argument that is access criteria

forceNoAddress

public void forceNoAddress()

This will ensure the function will never have an address for the action. This is typically true for search actions.

getInputArguments

public abstract NamedList<ArgumentContent> getInputArguments()

Returns:

the list of argument contents

isAddressGenerated

public boolean isAddressGenerated(NamedList<ArgumentContent> inputarguments)

depending on the arguments, the action can have an address generated that is similar to an URL link. Only some type of arguments can be put in an address (object id, text...)

Parameters:

inputarguments - list of input argumennts

Returns:

true if the address can be generated

getSecurityobjectargument

public abstract ObjectArgument getSecurityobjectargument()

this method returns the object argument used for security if it exists

Returns:

the object method argument used for security

getSecurityobjectidargument

public abstract ObjectIdArgument getSecurityobjectidargument()

this method returns the object argument id used for security if it exists

Returns:

the object method argument id used for security

isAutogenerated

public boolean isAutogenerated()

Returns:

true if the action is auto-generated by the framework

setModule

public void setModule(Module module)

sets the parent module

Parameters:

module - the module to add

addBusinessRule

public void addBusinessRule(java.lang.String businessrule)

adds a business rule (in plain text) for the action rules to be added to the action javadoc

Parameters:

businessrule - business rule to add

addOutputArgument

public void addOutputArgument(ArgumentContent thisargument)

adds an output argument to this action

Parameters:

thisargument - argument to add

isAccessCriteriaInput

public boolean isAccessCriteriaInput()

Returns:

true if the access criteria is in input

getAccessCriteria

public ArgumentContent getAccessCriteria()

Returns:

get the access criteria (input or output)

addOutputArgumentAsAccessCriteria

public void addOutputArgumentAsAccessCriteria(ArgumentContent thisargument)

adds this output argument as security criteria. Typically, this requires the server to filter the data and only show it if user has visualization right on it

Parameters:

thisargument - argument to add as output access criteria

generateToFile

public void generateToFile(SourceGenerator sg,
                           Module module)
                    throws java.io.IOException

generates the abstract class of the action to file. This provides a framework for user to add their code to

Parameters:

sg - source generator

module - parent module

Throws:

java.io.IOException - if anything bad happens while writing the file.