org.openlowcode.design.data

Class ArgumentContent

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.design.data.ArgumentContent

All Implemented Interfaces:

NamedInterface

Direct Known Subclasses:

ArrayArgument, BigDecimalArgument, BooleanArgument, ChoiceArgument, FaultyStringArgument, IntegerArgument, LargeBinaryArgument, MultipleChoiceArgument, NodeTreeArgument, ObjectArgument, ObjectIdArgument, ObjectMasterIdArgument, StringArgument, ThreeObjectsArgument, TimePeriodArgument, TimestampArgument, TwoObjectsArgument

public abstract class ArgumentContent
extends Named

An argument content describes the name and data type of an argument to an action

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
ArgumentContent(java.lang.String name, boolean securityrelevant) creates a new argument content

Method Summary

Modifier and Type	Method and Description
abstract ArgumentContent	generateCopy(java.lang.String newname) generates a deep copy of the argument with a new name
java.lang.String	getDisplaylabel()
abstract java.lang.String	getGenericDataEltName()
abstract java.util.ArrayList<java.lang.String>	getImports()
abstract DataObjectDefinition	getMasterObject() This method is used to assess if a security argument is used in a manner compatible with security rules
abstract java.lang.String	getPreciseDataEltName()
abstract java.lang.String	getPreciseDataEltTypeName()
java.lang.String	getPreciseDataEltTypeNameWithArgument()
abstract java.lang.String	getType()
abstract java.lang.String	initblank()
boolean	isOptional()
boolean	isSecurityrelevant() A security relevant argument is tested against user privileges.
abstract boolean	needDefinitionForInit()
void	setDisplaylabel(java.lang.String displaylabel) sets the display label for this argument content.
void	setOptional(boolean optional) sets the argument content as optional
abstract void	writeImports(SourceGenerator sg, Module module) writes to a java class the imports necessary for automatic generation of actions using this parameter

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

ArgumentContent

public ArgumentContent(java.lang.String name,
                       boolean securityrelevant)

creates a new argument content

Parameters:

name - name of the argument, should be unique per function

securityrelevant - tells if the attribute should be used as a base for security access rights computation. This attribute does not make sense for all types of arguments. It is typically only relevant for objects and object ids

Method Detail

getDisplaylabel

public java.lang.String getDisplaylabel()

Returns:

the display label of the argument when used for creation of an object

setDisplaylabel

public void setDisplaylabel(java.lang.String displaylabel)

sets the display label for this argument content. This is only needed if the argument content is used to describe data to enter for property at object creation or update

Parameters:

displaylabel - display label (plain English description)

getType

public abstract java.lang.String getType()

Returns:

the java type of the argument

isSecurityrelevant

public boolean isSecurityrelevant()

A security relevant argument is tested against user privileges. The input object ids will be tested against privileges and potentially action access will be prevented. For output objects, they are filtered to give back only the objects the users have access to.

Returns:

true if the argument content is security relevant for an action.

generateCopy

public abstract ArgumentContent generateCopy(java.lang.String newname)

generates a deep copy of the argument with a new name

Parameters:

newname - new name

Returns:

deep copy of the argument

isOptional

public boolean isOptional()

Returns:

true is the argument is optional

setOptional

public void setOptional(boolean optional)

sets the argument content as optional

Parameters:

optional - true to set the argument content as optional

getGenericDataEltName

public abstract java.lang.String getGenericDataEltName()

Returns:

a generic data element . For Objects, this means returning a simple ObjectDataElt name.

getPreciseDataEltTypeName

public abstract java.lang.String getPreciseDataEltTypeName()

Returns:

a precise data element type. For objects, this means returning a TobjectDataEltType where E is a data object

getPreciseDataEltTypeNameWithArgument

public java.lang.String getPreciseDataEltTypeNameWithArgument()

Returns:

a precise data element type with argument. For objects, this means returning a TobjectDataEltType where E is a data object

needDefinitionForInit

public abstract boolean needDefinitionForInit()

Returns:

true if an objectdefinition needs to be provided to create the type (typically an opject or an object array), false if the type can be created without such oject

getPreciseDataEltName

public abstract java.lang.String getPreciseDataEltName()

Returns:

a precise data element . For objects, this means returning a TobjectDataElt where E is a data object

writeImports

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

writes to a java class the imports necessary for automatic generation of actions using this parameter

Parameters:

sg - source generator

module - parent module

Throws:

java.io.IOException - if any error is encountered writing to a file

getImports

public abstract java.util.ArrayList<java.lang.String> getImports()

Returns:

all the java types needed for code generation when the argument content is set

initblank

public abstract java.lang.String initblank()

Returns:

a blank objet for this argument

getMasterObject

public abstract DataObjectDefinition getMasterObject()

This method is used to assess if a security argument is used in a manner compatible with security rules

Returns:

null if the attribute refers to several objects or to no object (e.g. a stringargument refers to no object).