com.businessobjects.query
Interface Values

All Superinterfaces:

Operand

public interface Values
extends Operand

The interface Values contains a set of values from a lov (ValueFromLov and plain String values, also called free values.

It is used to specify the default values for a Prompt. It can also be used as an Operand of a Filter condition.

See Also:

Prompt, Operand, Filter, ValueFromLov

Nested Class Summary

static class

Values.Factory A class with methods for creating instances of the Values type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

void	addFreeValue(java.lang.String freeValue) Appends the value as the last FreeValue element.
org.apache.xmlbeans.XmlString	addNewFreeValue() Appends and returns a new empty value (as xml) as the last FreeValue element
org.apache.xmlbeans.XmlObject	addNewNativeFreeValue() Appends and returns a new empty value (as xml) as the last NativeFreeValue element
ValueFromLov	addNewValueFromLov() Appends and returns a new empty value (as xml) as the last ValueFromLov element.
java.lang.String[]	getFreeValueArray() Gets the String array containing the free values of the Values set.
java.lang.String	getFreeValueArray(int i) Gets the free value of the Values set specified by the array index i.
org.apache.xmlbeans.XmlObject[]	getNativeFreeValueArray() Gets the free value of the Values set specified by the array index i.
org.apache.xmlbeans.XmlObject	getNativeFreeValueArray(int i) Gets the native free value of the Values set specified by the array index i.
ValueFromLov[]	getValueFromLovArray() Gets the ValueFromLov array containing the LOV values of the Values set.
ValueFromLov	getValueFromLovArray(int i) Gets the ValueFromLov of the Values set specified by the array index i.
void	insertFreeValue(int i, java.lang.String freeValue) Inserts the value of the FreeValue element at the specified index position.
org.apache.xmlbeans.XmlString	insertNewFreeValue(int i) Inserts and returns a new empty value (as xml) of the FreeValue element at the specified index position.
org.apache.xmlbeans.XmlObject	insertNewNativeFreeValue(int i) Inserts and returns a new empty value (as xml) as the ith NativeFreeValue element
ValueFromLov	insertNewValueFromLov(int i) Inserts and returns a new empty value (as xml) of the "ValueFromLov" element at the specified index position,
boolean	isNilNativeFreeValueArray(int i) Checks if the NativeFreeValue element is nil at the specified index position.
void	removeFreeValue(int i) Removes the FreeValue element at the specified index position.
void	removeNativeFreeValue(int i) Removes the NativeFreeValue element at the specified index position.
void	removeValueFromLov(int i) Removes the ValueFromLov element at the specified index position
void	setFreeValueArray(int i, java.lang.String freeValue) Sets the free value of the Values set specified by the array index i with the parameter value.
void	setFreeValueArray(java.lang.String[] freeValueArray) Sets the String array containing the free values of the Values set.
void	setNativeFreeValueArray(int i, org.apache.xmlbeans.XmlObject nativeFreeValue) Sets the native free value of the Values set specified by the array index i with the parameter value.
void	setNativeFreeValueArray(org.apache.xmlbeans.XmlObject[] nativeFreeValueArray) Sets the XmlObject array containing the free values of the Values set.
void	setNilNativeFreeValueArray(int i) Nils the "NativeFreeValue" element at the specified index position.
void	setValueFromLovArray(int i, ValueFromLov valueFromLov) Sets the ValueFromLov of the Values set specified by the array index i with the parameter value.
void	setValueFromLovArray(ValueFromLov[] valueFromLovArray) Sets the ValueFromLov array containing the LOV values of the Values set specified by the array index i with the parameter valueFromLov.
int	sizeOfFreeValueArray() Returns number of FreeValue element
int	sizeOfNativeFreeValueArray() Returns the size of native free value array.
int	sizeOfValueFromLovArray() Returns size of ValueFromLov array.
org.apache.xmlbeans.XmlString[]	xgetFreeValueArray() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetFreeValueArray(int i) Internal Use Only.
void	xsetFreeValueArray(int i, org.apache.xmlbeans.XmlString freeValue) Internal Use Only.
void	xsetFreeValueArray(org.apache.xmlbeans.XmlString[] freeValueArray) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getFreeValueArray

java.lang.String[] getFreeValueArray()

Gets the String array containing the free values of the Values set.

Returns:

the String array containing the free values

getFreeValueArray

java.lang.String getFreeValueArray(int i)

Gets the free value of the Values set specified by the array index i.

Parameters:

i - the index of the free value to be retrieved (using a zero-based index)

Returns:

the requested free value

xgetFreeValueArray

org.apache.xmlbeans.XmlString[] xgetFreeValueArray()

Internal Use Only.

xgetFreeValueArray

org.apache.xmlbeans.XmlString xgetFreeValueArray(int i)

Internal Use Only.

sizeOfFreeValueArray

int sizeOfFreeValueArray()

Returns number of FreeValue element

Returns:

the size of the FreeValue array

setFreeValueArray

void setFreeValueArray(java.lang.String[] freeValueArray)

Sets the String array containing the free values of the Values set.

Parameters:

freeValueArray - the String array containing the free values

setFreeValueArray

void setFreeValueArray(int i,
                       java.lang.String freeValue)

Sets the free value of the Values set specified by the array index i with the parameter value.

Parameters:

i - the index of the free value to be set (using a zero-based index)

value - the free value to store

xsetFreeValueArray

void xsetFreeValueArray(org.apache.xmlbeans.XmlString[] freeValueArray)

Internal Use Only.

xsetFreeValueArray

void xsetFreeValueArray(int i,
                        org.apache.xmlbeans.XmlString freeValue)

Internal Use Only.

insertFreeValue

void insertFreeValue(int i,
                     java.lang.String freeValue)

Inserts the value of the FreeValue element at the specified index position.

Parameters:

i - the index of the FreeValue element.

freeValue - the String containing free values.

addFreeValue

void addFreeValue(java.lang.String freeValue)

Appends the value as the last FreeValue element.

Parameters:

freeValue - the String containing free values.

insertNewFreeValue

org.apache.xmlbeans.XmlString insertNewFreeValue(int i)

Inserts and returns a new empty value (as xml) of the FreeValue element at the specified index position.

Parameters:

i - the index of the FreeValue element

Returns:

a new empty value (as xml) of the FreeValue element at the specified index position.

addNewFreeValue

org.apache.xmlbeans.XmlString addNewFreeValue()

Appends and returns a new empty value (as xml) as the last FreeValue element

Returns:

The value of the new empty FreeValue element.

removeFreeValue

void removeFreeValue(int i)

Removes the FreeValue element at the specified index position.

Parameters:

i - the index of the free value element.

getNativeFreeValueArray

org.apache.xmlbeans.XmlObject[] getNativeFreeValueArray()

Gets the free value of the Values set specified by the array index i.

Returns:

the requested native free value

getNativeFreeValueArray

org.apache.xmlbeans.XmlObject getNativeFreeValueArray(int i)

Gets the native free value of the Values set specified by the array index i.

Parameters:

i - the index of the native free value to be retrieved (using a zero-based index)

Returns:

the requested native free value

isNilNativeFreeValueArray

boolean isNilNativeFreeValueArray(int i)

Checks if the NativeFreeValue element is nil at the specified index position.

Parameters:

i - the index of the native free value to be retrieved (using a zero-based index)

Returns:

true if the native free value element is nil, otherwise false

sizeOfNativeFreeValueArray

int sizeOfNativeFreeValueArray()

Returns the size of native free value array.

Returns:

the size of native free value array.

setNativeFreeValueArray

void setNativeFreeValueArray(org.apache.xmlbeans.XmlObject[] nativeFreeValueArray)

Sets the XmlObject array containing the free values of the Values set.

Parameters:

nativeFreeValueArray - the XmlObject array containing the free values

setNativeFreeValueArray

void setNativeFreeValueArray(int i,
                             org.apache.xmlbeans.XmlObject nativeFreeValue)

Sets the native free value of the Values set specified by the array index i with the parameter value.

Parameters:

i - the index of the free value to be set (using a zero-based index)

nativeFreeValue - the native free value to store

setNilNativeFreeValueArray

void setNilNativeFreeValueArray(int i)

Nils the "NativeFreeValue" element at the specified index position.

Parameters:

i - the index of the native free value element

insertNewNativeFreeValue

org.apache.xmlbeans.XmlObject insertNewNativeFreeValue(int i)

Inserts and returns a new empty value (as xml) as the ith NativeFreeValue element

Parameters:

i - the index of the native free value element

Returns:

a new empty value (as xml) as the ith NativeFreeValue element

addNewNativeFreeValue

org.apache.xmlbeans.XmlObject addNewNativeFreeValue()

Appends and returns a new empty value (as xml) as the last NativeFreeValue element

Returns:

a new empty value (as xml) as the last NativeFreeValue element

removeNativeFreeValue

void removeNativeFreeValue(int i)

Removes the NativeFreeValue element at the specified index position.

Parameters:

i - the index of the native free value element

getValueFromLovArray

ValueFromLov[] getValueFromLovArray()

Gets the ValueFromLov array containing the LOV values of the Values set.

Returns:

the ValueFromLov array containing the LOV values

getValueFromLovArray

ValueFromLov getValueFromLovArray(int i)

Gets the ValueFromLov of the Values set specified by the array index i.

Parameters:

i - the index of the ValueFromLov to be retrieved (using a zero-based index)

Returns:

the requested ValueFromLov instance

sizeOfValueFromLovArray

int sizeOfValueFromLovArray()

Returns size of ValueFromLov array.

Returns:

size of ValueFromLov array.

setValueFromLovArray

void setValueFromLovArray(ValueFromLov[] valueFromLovArray)

Sets the ValueFromLov array containing the LOV values of the Values set specified by the array index i with the parameter valueFromLov.

Parameters:

valueFromLovArray - the ValueFromLov array containing the LOV values

setValueFromLovArray

void setValueFromLovArray(int i,
                          ValueFromLov valueFromLov)

Sets the ValueFromLov of the Values set specified by the array index i with the parameter value.

Parameters:

i - the index of the ValueFromLov to be set (using a zero-based index)

valueFromLov - the ValueFromLov instance to store

insertNewValueFromLov

ValueFromLov insertNewValueFromLov(int i)

Inserts and returns a new empty value (as xml) of the "ValueFromLov" element at the specified index position,

Parameters:

i - The index position.

addNewValueFromLov

ValueFromLov addNewValueFromLov()

Appends and returns a new empty value (as xml) as the last ValueFromLov element.

Returns:

a new empty value (as xml) as the last "ValueFromLov" element.

removeValueFromLov

void removeValueFromLov(int i)

Removes the ValueFromLov element at the specified index position

Parameters:

i - The index position.