com.businessobjects.enterprise.infoobject
Interface CustomProperties

public interface CustomProperties

The custom properties collection allows you to define your own InfoObject properties.

Nested Class Summary

static interface	CustomProperties.Bool Represents a custom boolean property.
static interface	CustomProperties.Date Represents a custom date property.
static interface	CustomProperties.Double Represents a custom double property.
static class	CustomProperties.Factory A class with methods for creating instances of the CustomProperties type.
static interface	CustomProperties.Integer Represents an custom integer property.
static interface	CustomProperties.String Represents a custom string property.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

CustomProperties	addNewBag() Appends and returns a new empty CustomProperties object as the last element of the array.
CustomProperties.Bool	addNewBool() Appends and returns a new empty CustomProperties.String object as the last element of the array.
CustomRelation	addNewCustomRelation() Appends and returns a new empty CustomRelation object as the last element of the array.
CustomProperties.Date	addNewDate() Appends and returns a new empty CustomProperties.Date object as the last element of the array.
CustomProperties.Double	addNewDouble() Appends and returns a new empty CustomProperties.Double object as the last element of the array.
CustomProperties.Integer	addNewInteger() Appends and returns a new empty CustomProperties Integer object as the last element of the array.
CustomProperties.String	addNewString() Appends and returns a new empty CustomProperties.String object as the last element of the array.
CustomProperties[]	getBagArray() Returns the array of CustomProperties objects.
CustomProperties	getBagArray(int i) Returns the CustomProperties object at the specified index position.
CustomProperties.Bool[]	getBoolArray() Returns the array of CustomProperties.Bool objects.
CustomProperties.Bool	getBoolArray(int i) Returns the CustomProperties.Bool object at the specified index position.
CustomRelation[]	getCustomRelationArray() Returns the array of CustomRelation objects.
CustomRelation	getCustomRelationArray(int i) Returns the CustomRelation object at the specified index position.
CustomProperties.Date[]	getDateArray() Returns the array of CustomProperties.Date objects.
CustomProperties.Date	getDateArray(int i) Returns the CustomProperties.Date object at the specified index position.
CustomProperties.Double[]	getDoubleArray() Returns the array of CustomProperties.Double objects.
CustomProperties.Double	getDoubleArray(int i) Returns the CustomProperties.Double object at the specified index position.
CustomProperties.Integer[]	getIntegerArray() Returns the array of CustomProperties.Integer objects.
CustomProperties.Integer	getIntegerArray(int i) Returns the CustomProperties.Integer object at the specified index position.
java.lang.String	getNameID() Returns the property name.
boolean	getProcessingProp() Internal Use Only.
CustomProperties.String[]	getStringArray() Returns the array of CustomProperties.String objects.
CustomProperties.String	getStringArray(int i) Returns the CustomProperties.String object at the specified index position.
CustomProperties	insertNewBag(int i) Inserts and returns a new empty CustomProperties object at a specified index.
CustomProperties.Bool	insertNewBool(int i) Inserts and returns a new empty Bool object at a specified index.
CustomRelation	insertNewCustomRelation(int i) Inserts and returns a new empty CustomRelation object at a specified index.
CustomProperties.Date	insertNewDate(int i) Inserts and returns a new empty Date object at a specified index.
CustomProperties.Double	insertNewDouble(int i) Inserts and returns a new empty Double object at a specified index.
CustomProperties.Integer	insertNewInteger(int i) Inserts and returns a new empty CustomProperties Integer object at a specified index.
CustomProperties.String	insertNewString(int i) Inserts and returns a new empty String object at a specified index.
boolean	isSetNameID() Checks if the NameID has been set.
boolean	isSetProcessingProp() Internal Use Only.
void	removeBag(int i) Removes the Bag element at the specified index position.
void	removeBool(int i) Removes the Bool element at the specified index position.
void	removeCustomRelation(int i) Removes the CustomRelation element at the specified index position.
void	removeDate(int i) Removes the Date element at the specified index position.
void	removeDouble(int i) Removes the Double element at the specified index position.
void	removeInteger(int i) Removes the Integer element at the specified index position.
void	removeString(int i) Removes the String element at the specified index position.
void	setBagArray(CustomProperties[] bagArray) Sets the array of CustomProperties objects.
void	setBagArray(int i, CustomProperties bag) Sets the CustomProperties object at the specified index position.
void	setBoolArray(CustomProperties.Bool[] boolArray) Sets the array of CustomProperties.Bool objects.
void	setBoolArray(int i, CustomProperties.Bool bool) Returns the CustomProperties.Bool object at the specified index position.
void	setCustomRelationArray(CustomRelation[] customRelationArray) Sets the array of CustomRelation objects.
void	setCustomRelationArray(int i, CustomRelation customRelation) Sets the CustomRelation object at the specified index position.
void	setDateArray(CustomProperties.Date[] dateArray) Sets the array of CustomProperties.Date objects.
void	setDateArray(int i, CustomProperties.Date date) Sets the CustomProperties.Date object at the specified index position.
void	setDoubleArray(CustomProperties.Double[] xdoubleArray) Sets the array of CustomProperties.Double objects.
void	setDoubleArray(int i, CustomProperties.Double xdouble) Sets the CustomProperties.Double object at the specified index position.
void	setIntegerArray(CustomProperties.Integer[] integerArray) Sets the array of CustomProperties Integer objects.
void	setIntegerArray(int i, CustomProperties.Integer integer) Sets the CustomProperties Integer object at the specified index position.
void	setNameID(java.lang.String nameID) Internal Use Only.
void	setProcessingProp(boolean processingProp) Internal Use Only.
void	setStringArray(CustomProperties.String[] stringArray) Sets the array of CustomProperties.String objects.
void	setStringArray(int i, CustomProperties.String string) Sets the CustomProperties.String object at the specified index position.
int	sizeOfBagArray() Returns the size of the BagArray.
int	sizeOfBoolArray() Returns the size of the BoolArray.
int	sizeOfCustomRelationArray() Returns the size of the CustomRelationArray.
int	sizeOfDateArray() Returns the size of the DateArray.
int	sizeOfDoubleArray() Returns the size of the DoubleArray.
int	sizeOfIntegerArray() Returns the size of the IntegerArray.
int	sizeOfStringArray() Returns the size of the StringArray.
void	unsetNameID() Deletes or unsets the NameID element.
void	unsetProcessingProp() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetNameID() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetProcessingProp() Internal Use Only.
void	xsetNameID(org.apache.xmlbeans.XmlString nameID) Internal Use Only.
void	xsetProcessingProp(org.apache.xmlbeans.XmlBoolean processingProp) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getIntegerArray

CustomProperties.Integer[] getIntegerArray()

Returns the array of CustomProperties.Integer objects.

Returns:

The array of CustomProperties.Integer objects.

getIntegerArray

CustomProperties.Integer getIntegerArray(int i)

Returns the CustomProperties.Integer object at the specified index position.

Parameters:

i - The index position.

Returns:

The CustomProperties.Integer object.

sizeOfIntegerArray

int sizeOfIntegerArray()

Returns the size of the IntegerArray.

Returns:

The size of the array.

setIntegerArray

void setIntegerArray(CustomProperties.Integer[] integerArray)

Sets the array of CustomProperties Integer objects.

Parameters:

integerArray - The array of CustomProperties Integer objects.

setIntegerArray

void setIntegerArray(int i,
                     CustomProperties.Integer integer)

Sets the CustomProperties Integer object at the specified index position.

Parameters:

i - The index position.

integer - The CustomProperties Integer object.

insertNewInteger

CustomProperties.Integer insertNewInteger(int i)

Inserts and returns a new empty CustomProperties Integer object at a specified index.

Parameters:

i - The index position to insert the object.

Returns:

The new Custom Property Integer object.

addNewInteger

CustomProperties.Integer addNewInteger()

Appends and returns a new empty CustomProperties Integer object as the last element of the array.

Returns:

The new CustomProperties.Integer object.

removeInteger

void removeInteger(int i)

Removes the Integer element at the specified index position.

Parameters:

i - The index position to remove the CustomProperties.Integer object.

getStringArray

CustomProperties.String[] getStringArray()

Returns the array of CustomProperties.String objects.

Returns:

The array of CustomProperties string objects.

getStringArray

CustomProperties.String getStringArray(int i)

Returns the CustomProperties.String object at the specified index position.

Parameters:

i - The index position.

Returns:

The CustomProperties.String object.

sizeOfStringArray

int sizeOfStringArray()

Returns the size of the StringArray.

Returns:

The size of the array.

setStringArray

void setStringArray(CustomProperties.String[] stringArray)

Sets the array of CustomProperties.String objects.

Parameters:

stringArray - The array of CustomProperties.String objects.

setStringArray

void setStringArray(int i,
                    CustomProperties.String string)

Sets the CustomProperties.String object at the specified index position.

Parameters:

i - The index position.

string - The CustomProperties.String object.

insertNewString

CustomProperties.String insertNewString(int i)

Inserts and returns a new empty String object at a specified index.

Parameters:

i - The index position to insert the object.

Returns:

The new String object.

addNewString

CustomProperties.String addNewString()

Appends and returns a new empty CustomProperties.String object as the last element of the array.

Returns:

The new CustomProperties.String object.

removeString

void removeString(int i)

Removes the String element at the specified index position.

Parameters:

i - The index position to remove the CustomProperties.String object.

getBoolArray

CustomProperties.Bool[] getBoolArray()

Returns the array of CustomProperties.Bool objects.

Returns:

The array of CustomProperties.Bool objects.

getBoolArray

CustomProperties.Bool getBoolArray(int i)

Returns the CustomProperties.Bool object at the specified index position.

Parameters:

i - The index position.

Returns:

The CustomProperties.Bool object.

sizeOfBoolArray

int sizeOfBoolArray()

Returns the size of the BoolArray.

Returns:

The size of the array.

setBoolArray

void setBoolArray(CustomProperties.Bool[] boolArray)

Sets the array of CustomProperties.Bool objects.

Parameters:

boolArray - The array of CustomProperties.Bool objects.

setBoolArray

void setBoolArray(int i,
                  CustomProperties.Bool bool)

Returns the CustomProperties.Bool object at the specified index position.

Parameters:

i - The index position.

bool - The CustomProperties.Bool object.

insertNewBool

CustomProperties.Bool insertNewBool(int i)

Inserts and returns a new empty Bool object at a specified index.

Parameters:

i - The index position to insert the object.

Returns:

The new Bool object.

addNewBool

CustomProperties.Bool addNewBool()

Appends and returns a new empty CustomProperties.String object as the last element of the array.

Returns:

The new CustomProperties.String object.

removeBool

void removeBool(int i)

Removes the Bool element at the specified index position.

Parameters:

i - The index position to remove the CustomProperties.Bool object.

getDateArray

CustomProperties.Date[] getDateArray()

Returns the array of CustomProperties.Date objects.

Returns:

The array of CustomProperties.Date objects.

getDateArray

CustomProperties.Date getDateArray(int i)

Returns the CustomProperties.Date object at the specified index position.

Parameters:

i - The index position.

Returns:

The CustomProperties.Date object.

sizeOfDateArray

int sizeOfDateArray()

Returns the size of the DateArray.

Returns:

The size of the array.

setDateArray

void setDateArray(CustomProperties.Date[] dateArray)

Sets the array of CustomProperties.Date objects.

Parameters:

dateArray - The array of CustomProperties.Date objects.

setDateArray

void setDateArray(int i,
                  CustomProperties.Date date)

Sets the CustomProperties.Date object at the specified index position.

Parameters:

i - The index position.

date - The CustomProperties.Date object.

insertNewDate

CustomProperties.Date insertNewDate(int i)

Inserts and returns a new empty Date object at a specified index.

Parameters:

i - The index position to insert the object.

Returns:

The new Date object.

addNewDate

CustomProperties.Date addNewDate()

Appends and returns a new empty CustomProperties.Date object as the last element of the array.

Returns:

The new CustomProperties.Date object.

removeDate

void removeDate(int i)

Removes the Date element at the specified index position.

Parameters:

i - The index position to remove the CustomProperties.Date object.

getDoubleArray

CustomProperties.Double[] getDoubleArray()

Returns the array of CustomProperties.Double objects.

Returns:

The array of CustomProperties.Double objects.

getDoubleArray

CustomProperties.Double getDoubleArray(int i)

Returns the CustomProperties.Double object at the specified index position.

Parameters:

i - The index position.

Returns:

The CustomProperties.Double object.

sizeOfDoubleArray

int sizeOfDoubleArray()

Returns the size of the DoubleArray.

Returns:

The size of the array.

setDoubleArray

void setDoubleArray(CustomProperties.Double[] xdoubleArray)

Sets the array of CustomProperties.Double objects.

Parameters:

xdoubleArray - The array of CustomProperties.Double objects.

setDoubleArray

void setDoubleArray(int i,
                    CustomProperties.Double xdouble)

Sets the CustomProperties.Double object at the specified index position.

Parameters:

i - The index position.

xdouble - The CustomProperties.Double object.

insertNewDouble

CustomProperties.Double insertNewDouble(int i)

Inserts and returns a new empty Double object at a specified index.

Parameters:

i - The index position to insert the object.

Returns:

The new Double object.

addNewDouble

CustomProperties.Double addNewDouble()

Appends and returns a new empty CustomProperties.Double object as the last element of the array.

Returns:

The new CustomProperties.Double object.

removeDouble

void removeDouble(int i)

Removes the Double element at the specified index position.

Parameters:

i - The index position to remove the CustomProperties.Double object.

getCustomRelationArray

CustomRelation[] getCustomRelationArray()

Returns the array of CustomRelation objects.

Returns:

The array of CustomRelation objects.

getCustomRelationArray

CustomRelation getCustomRelationArray(int i)

Returns the CustomRelation object at the specified index position.

Parameters:

i - The index position.

Returns:

The CustomRelation object.

sizeOfCustomRelationArray

int sizeOfCustomRelationArray()

Returns the size of the CustomRelationArray.

Returns:

The size of the array.

setCustomRelationArray

void setCustomRelationArray(CustomRelation[] customRelationArray)

Sets the array of CustomRelation objects.

Parameters:

customRelationArray - The array of CustomRelation objects.

setCustomRelationArray

void setCustomRelationArray(int i,
                            CustomRelation customRelation)

Sets the CustomRelation object at the specified index position.

Parameters:

i - The index position.

customRelation - The CustomRelation object.

insertNewCustomRelation

CustomRelation insertNewCustomRelation(int i)

Inserts and returns a new empty CustomRelation object at a specified index.

Parameters:

i - The index position to insert the object.

Returns:

The new CustomRelation object.

addNewCustomRelation

CustomRelation addNewCustomRelation()

Appends and returns a new empty CustomRelation object as the last element of the array.

Returns:

The new CustomRelation object.

removeCustomRelation

void removeCustomRelation(int i)

Removes the CustomRelation element at the specified index position.

Parameters:

i - The index position to remove the CustomRelation object.

getBagArray

CustomProperties[] getBagArray()

Returns the array of CustomProperties objects.

Returns:

The array of CustomProperties objects.

getBagArray

CustomProperties getBagArray(int i)

Returns the CustomProperties object at the specified index position.

Parameters:

i - The index position.

Returns:

The CustomProperties object.

sizeOfBagArray

int sizeOfBagArray()

Returns the size of the BagArray.

Returns:

The size of the array.

setBagArray

void setBagArray(CustomProperties[] bagArray)

Sets the array of CustomProperties objects.

Parameters:

bagArray - The array of CustomProperties objects.

setBagArray

void setBagArray(int i,
                 CustomProperties bag)

Sets the CustomProperties object at the specified index position.

Parameters:

i - The index position.

bag - The CustomProperties object.

insertNewBag

CustomProperties insertNewBag(int i)

Inserts and returns a new empty CustomProperties object at a specified index.

Parameters:

i - The index position to insert the object.

Returns:

The new CustomProperties object.

addNewBag

CustomProperties addNewBag()

Appends and returns a new empty CustomProperties object as the last element of the array.

Returns:

The new CustomProperties object.

removeBag

void removeBag(int i)

Removes the Bag element at the specified index position.

Parameters:

i - The index position to remove the Bag object.

getNameID

java.lang.String getNameID()

Returns the property name.

Returns:

Returns the property name.

xgetNameID

org.apache.xmlbeans.XmlString xgetNameID()

Internal Use Only.

isSetNameID

boolean isSetNameID()

Checks if the NameID has been set.

Returns:

true if the NameID element has been set, otherwise false.

setNameID

void setNameID(java.lang.String nameID)

Internal Use Only.

xsetNameID

void xsetNameID(org.apache.xmlbeans.XmlString nameID)

Internal Use Only.

unsetNameID

void unsetNameID()

Deletes or unsets the NameID element.

getProcessingProp

boolean getProcessingProp()

Internal Use Only.

xgetProcessingProp

org.apache.xmlbeans.XmlBoolean xgetProcessingProp()

Internal Use Only.

isSetProcessingProp

boolean isSetProcessingProp()

Internal Use Only.

setProcessingProp

void setProcessingProp(boolean processingProp)

Internal Use Only.

xsetProcessingProp

void xsetProcessingProp(org.apache.xmlbeans.XmlBoolean processingProp)

Internal Use Only.

unsetProcessingProp

void unsetProcessingProp()

Internal Use Only.