Package de.elo.ix.client

Class KeywordsDynamicResult

java.lang.Object

byps.BValueClass

de.elo.ix.client.ValueClass

de.elo.ix.client.KeywordsDynamicResult

All Implemented Interfaces:

Serializable

public class KeywordsDynamicResult
extends ValueClass
implements Serializable

The class KeywordsDynamicResult defines the return value of the IX call IXServicePortIF.checkoutKeywordsDynamic(ClientInfo, KeywordsDynamicInfo) .

Since:

9.00.000.001

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Map<String,String>>	columnProperties	List of column properties.
protected List<String>	header	This list contains the column descriptions to be displayed as the header of the table at the client.
protected List<String>	keyNames	List of key names.
protected String	message	The executed script may provide additional informations to the client such as "Please fill field XYZ".
protected boolean	moreResults	Is true if there are more results.
protected List<List<String>>	table	This value contains the result set as a table.
protected String	title	A brief and succinctly description about the represented data.

Fields inherited from class byps.BValueClass

bypsClient, changedMembers, dbHelper, FLAG_SEALED, flags

Constructor Summary

Constructors

Constructor	Description
KeywordsDynamicResult()
KeywordsDynamicResult(KeywordsDynamicResult rhs)

Method Summary

Modifier and Type	Method	Description
List<Map<String,String>>	getColumnProperties()
List<String>	getHeader()
List<String>	getKeyNames()
String	getMessage()
List<List<String>>	getTable()
String	getTitle()
boolean	isMoreResults()
void	setColumnProperties(List<Map<String,String>> columnProperties)
void	setHeader(List<String> header)
void	setKeyNames(List<String> keyNames)
void	setMessage(String message)
void	setMoreResults(boolean moreResults)
void	setTable(List<List<String>> table)
void	setTitle(String title)
String	toString()

Methods inherited from class byps.BValueClass

getBypsClient, getChangedMembers, getDbHelper, isChangedMember, isSealed, seal, seal, setBypsClient, setChangedMember, setChangedMembers, setDbHelper

Methods inherited from class java.lang.Object

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

Field Details

table

protected List<List<String>> table

This value contains the result set as a table. Each entry of the outer list represents a row in the table. Thus, the entry i of an inner list represents the value of the i. column of the actual row. The length of each inner list is identical to the total amount of columns. Entries without a value are represented by an empty string.

header

protected List<String> header

This list contains the column descriptions to be displayed as the header of the table at the client. The size of this list matches the amount of columns in table. The value at index i represents the column description of the column i. The first column index is 0. Columns without a header value must be represented by an empty or undefined string.

keyNames

protected List<String> keyNames

List of key names. The size of this list equals to header. In this list, columns without a key name are represented by null or an empty String.

message

protected String message

The executed script may provide additional informations to the client such as "Please fill field XYZ". Such informations are stored in the value message. The script has to provide the translation to the client's language.

moreResults

protected boolean moreResults

Is true if there are more results.

title

protected String title

A brief and succinctly description about the represented data. The script developer must provide a title, otherwise an exception is thrown.

Since:

9.00.000.010

columnProperties

protected List<Map<String,String>> columnProperties

List of column properties. The size of this list equals to header. If the value at position i is null, the client will use a default value for the properties of column i.

Since:

9.00.016.018

Constructor Details

KeywordsDynamicResult

public KeywordsDynamicResult()

KeywordsDynamicResult

public KeywordsDynamicResult(KeywordsDynamicResult rhs)

Method Details

getTable

public List<List<String>> getTable()

setTable

public void setTable(List<List<String>> table)

getHeader

public List<String> getHeader()

setHeader

public void setHeader(List<String> header)

getKeyNames

public List<String> getKeyNames()

setKeyNames

public void setKeyNames(List<String> keyNames)

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

isMoreResults

public boolean isMoreResults()

setMoreResults

public void setMoreResults(boolean moreResults)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getColumnProperties

public List<Map<String,String>> getColumnProperties()

setColumnProperties

public void setColumnProperties(List<Map<String,String>> columnProperties)

toString

public String toString()

Overrides:

toString in class Object