org.openlowcode.server.action

Class SActionRef

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.server.action.SActionRef

All Implemented Interfaces:

NamedInterface

Direct Known Subclasses:

SInlineActionRef

public class SActionRef
extends Named

an action received from the clients. Actions are executed, and provide as result a page and businessdata to fill the page

Author:

Open Lowcode SAS

Field Summary

Fields

Modifier and Type	Field and Description
protected NamedList<SActionDataLoc>	actiondata
protected NamedList<SNullActionInputDataRef>	nullactiondata

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SActionRef(java.lang.String name, java.lang.String module, int inputargumentindex) creates an action reference

Method Summary

Modifier and Type	Method and Description
protected void	addActionBusinessData(SActionDataLoc dataelt) adds action business data
SActionData	generatePotentialActionDataForSecurity(SPageData pagedata) generates the potential action data to check for security.
ActionExecution	getAction() gets the provided action execution
SActionDataLoc<?>	getActionData(java.lang.String name) gets the action data loc for the attribute with the given name
java.lang.String	getModule()
protected void	setNullActionBusinessData(SNullActionInputDataRef nullactioninput) adds a null action business data
void	writeAttributesInOrder(MessageWriter writer) writes the attribute in the order specified
void	writeToCML(MessageWriter writer) writes a reference to an action inside the widget

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

Field Detail

actiondata

protected NamedList<SActionDataLoc> actiondata

nullactiondata

protected NamedList<SNullActionInputDataRef> nullactiondata

Constructor Detail

SActionRef

protected SActionRef(java.lang.String name,
                     java.lang.String module,
                     int inputargumentindex)

creates an action reference

Parameters:

name - name of the action (unique for the module)

module - name of the module (unique)

inputargumentindex - 0 or more if there exists an inputargument index, -1 if there is no input security argument

Method Detail

getModule

public java.lang.String getModule()

Returns:

get the module of the action reference

addActionBusinessData

protected void addActionBusinessData(SActionDataLoc dataelt)

adds action business data

Parameters:

dataelt - location of the action business data on the page

setNullActionBusinessData

protected void setNullActionBusinessData(SNullActionInputDataRef nullactioninput)

adds a null action business data

Parameters:

nullactioninput - a null action business data

generatePotentialActionDataForSecurity

public SActionData generatePotentialActionDataForSecurity(SPageData pagedata)

generates the potential action data to check for security. This allows to hide buttons if the button for the action should be disabled

Parameters:

pagedata - pagedata

Returns:

an action data with the security argument, when relevant, filled at the correct sequence. Other attributes will not be filled.

writeAttributesInOrder

public void writeAttributesInOrder(MessageWriter writer)
                            throws java.io.IOException

writes the attribute in the order specified

Parameters:

writer - message writer

Throws:

java.io.IOException - if any error is encountered writing the message

writeToCML

public void writeToCML(MessageWriter writer)
                throws java.io.IOException

writes a reference to an action inside the widget

Parameters:

writer - message writer

Throws:

java.io.IOException - if any transmission error is encountered

getAction

public ActionExecution getAction()

gets the provided action execution

Returns:

action execution

getActionData

public SActionDataLoc<?> getActionData(java.lang.String name)

gets the action data loc for the attribute with the given name

Parameters:

name - name of the attribute

Returns:

the action data loc if it exists, else null