com.kabira.platform

Class KeyFieldValueList

java.lang.Object

com.kabira.platform.KeyFieldValueList

public class KeyFieldValueList
extends java.lang.Object

Class used to manage field values.

Constructor Summary

Constructors

Constructor and Description
KeyFieldValueList() Creates a KeyFieldValueList instance.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String fieldName, java.lang.Object value) Adds a field value pair.
void	clear() Removes all fields from the list.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyFieldValueList

public KeyFieldValueList()

Creates a KeyFieldValueList instance.

Method Detail

add

public void add(java.lang.String fieldName,
                java.lang.Object value)
         throws KeyNullValueError

Adds a field value pair.

Parameters:

fieldName - The field name.

value - The value to use.

Throws:

KeyNullValueError - The given value is null.

When executed, this defines the value used for the given field. These field/value pairs are used when forming the key for a query, or for setting additional fields when a getOrCreateSingleResult() call results in an instance being created by the runtime.

Adding the same field more than once will result in a KeyMalformedQueryError exception if this instance is passed to KeyQuery.defineQuery() for a non-ordered key.

clear

public void clear()

Removes all fields from the list.