org.openlowcode.design.data.argument

Class ObjectArgument

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.design.data.ArgumentContent

org.openlowcode.design.data.argument.ObjectArgument

All Implemented Interfaces:

NamedInterface

public class ObjectArgument
extends ArgumentContent

an argument holding the payload of an object

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
ObjectArgument(java.lang.String name, DataObjectDefinition payload)
ObjectArgument(java.lang.String name, DataObjectDefinition payload, boolean securityargument) creates an argument content holding the payload of an object

Method Summary

Modifier and Type	Method and Description
ArgumentContent	generateCopy(java.lang.String newname) generates a deep copy of the argument with a new name
java.lang.String	getGenericDataEltName()
java.util.ArrayList<java.lang.String>	getImports()
DataObjectDefinition	getMasterObject() This method is used to assess if a security argument is used in a manner compatible with security rules
DataObjectDefinition	getPayload()
java.lang.String	getPreciseDataEltName()
java.lang.String	getPreciseDataEltTypeName()
java.lang.String	getPreciseDataEltTypeNameWithArgument()
java.lang.String	getType()
java.lang.String	initblank()
boolean	needDefinitionForInit()
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.design.data.ArgumentContent

getDisplaylabel, isOptional, isSecurityrelevant, setDisplaylabel, setOptional

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

ObjectArgument

public ObjectArgument(java.lang.String name,
                      DataObjectDefinition payload)

ObjectArgument

public ObjectArgument(java.lang.String name,
                      DataObjectDefinition payload,
                      boolean securityargument)

creates an argument content holding the payload of an object

Parameters:

name - name of the argument, should be unique amongst input and output argument, should be a valid java field name

payload - the type of data object held as payload

securityargument - if true, this argument is the security argument. If input argument of an action, a check will be done before the action, if output argument of an action, data will be filtered before being sent to the client

Method Detail

getType

public java.lang.String getType()

Specified by:

getType in class ArgumentContent

Returns:

the java type of the argument

getGenericDataEltName

public java.lang.String getGenericDataEltName()

Specified by:

getGenericDataEltName in class ArgumentContent

Returns:

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

getPreciseDataEltTypeName

public java.lang.String getPreciseDataEltTypeName()

Specified by:

getPreciseDataEltTypeName in class ArgumentContent

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()

Overrides:

getPreciseDataEltTypeNameWithArgument in class ArgumentContent

Returns:

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

getPayload

public DataObjectDefinition getPayload()

needDefinitionForInit

public boolean needDefinitionForInit()

Specified by:

needDefinitionForInit in class ArgumentContent

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 java.lang.String getPreciseDataEltName()

Specified by:

getPreciseDataEltName in class ArgumentContent

Returns:

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

writeImports

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

Description copied from class: ArgumentContent

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

Specified by:

writeImports in class ArgumentContent

Parameters:

sg - source generator

module - parent module

Throws:

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

generateCopy

public ArgumentContent generateCopy(java.lang.String newname)

Description copied from class: ArgumentContent

generates a deep copy of the argument with a new name

Specified by:

generateCopy in class ArgumentContent

Parameters:

newname - new name

Returns:

deep copy of the argument

getImports

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

Specified by:

getImports in class ArgumentContent

Returns:

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

initblank

public java.lang.String initblank()

Specified by:

initblank in class ArgumentContent

Returns:

a blank objet for this argument

getMasterObject

public DataObjectDefinition getMasterObject()

Description copied from class: ArgumentContent

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

Specified by:

getMasterObject in class ArgumentContent

Returns:

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