org.openlowcode.server.action

Class SActionData

java.lang.Object

org.openlowcode.server.action.SActionData

public class SActionData
extends java.lang.Object

Data sent to the server to execute an action

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
SActionData() creates a void SActionData set
SActionData(MessageReader reader) creates an action data from an incoming message

Method Summary

Modifier and Type	Method and Description
void	addCLinkAttribute(java.lang.String name, java.lang.String payload) actions that have as input only object ids can be sent to the server through a CLink (equivalent to an http query with attribute)
void	addData(DataElt element) adds a data element to this action data set
DataElt	getAttribute(int index) gets the attribute at the specified index
DataElt	lookupAttributeOnName(java.lang.String name) gets an attribute by name
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

SActionData

public SActionData()

creates a void SActionData set

SActionData

public SActionData(MessageReader reader)
            throws OLcRemoteException,
                   java.io.IOException

creates an action data from an incoming message

Parameters:

reader - the reader to get payload from

Throws:

OLcRemoteException - exception to be sent back to the client

java.io.IOException - any IO exception while decoding the message

Method Detail

addCLinkAttribute

public void addCLinkAttribute(java.lang.String name,
                              java.lang.String payload)

actions that have as input only object ids can be sent to the server through a CLink (equivalent to an http query with attribute)

Parameters:

name - name of the attribute

payload - payload of the attribute

addData

public void addData(DataElt element)

adds a data element to this action data set

Parameters:

element - the element to add

size

public int size()

Returns:

the number of data elements in this action data set

getAttribute

public DataElt getAttribute(int index)

gets the attribute at the specified index

Parameters:

index - a number between 0 (included) and size (excluded)

Returns:

the requested data element, or an exception if out of range

lookupAttributeOnName

public DataElt lookupAttributeOnName(java.lang.String name)

gets an attribute by name

Parameters:

name - name of the attribute

Returns:

the attribute searched for, or null if it does not exist