com.legstar.coxb
Interface ICobolArrayComplexBinding

All Superinterfaces:

ICobolArrayBinding, ICobolBinding, ICobolElement

All Known Implementing Classes:

CArrayComplexBinding

public interface ICobolArrayComplexBinding
extends ICobolArrayBinding

This interface groups methods that are common to arrays of complex elements.

Author:

Fady Moussallam

Method Summary

void	addJaxbPropertyValue(int index) Deprecated. Request complex binding item to add a value to a jaxb bound object of the List type. The value is taken at index index in this binding array of values. Since bindings can now be bound to arbitrary value objects, use method addPropertyValue
void	addPropertyValue(int index) Request complex binding item to add a value to a bound value object of the List type.
void	createJaxbObject() Deprecated. Requests array to create a JAXB complex array. Since bindings can now be bound to arbitrary value objects, use method createValueObject instead of this one.
void	createValueObject() Requests array to create a complex value array.
ICobolComplexBinding	getComplexItemBinding() Returns the complex binding used for items of this array.
List<?>	getObjectList()
String	getValueObjectClassName() Complex bindings can be bound to JAXB objects or arbitrary POJOs jointly referred to as value objects.
String	getValueObjectsFactoryClassName() Optional factory class name used to create bound value objects.
void	setItemValue(int index) Requests complex array binding to set its item values from the JAXB item identified by index.
void	setObjectList(List<?> list)
void	setValueObjectClassName(String valueObjectClassName)
void	setValueObjectsFactoryClassName(String valueObjectsFactoryClassName)

Methods inherited from interface com.legstar.coxb.ICobolArrayBinding

calcItemByteLength, getCurrentOccurs, getItemByteLength, setItemByteLength

Methods inherited from interface com.legstar.coxb.ICobolBinding

accept, calcByteLength, getBindingName, getJaxbName, getJaxbType, getObjectValue, getParentBinding, isBound, isSet, setObjectValue

Methods inherited from interface com.legstar.coxb.ICobolElement

getByteLength, getCobolName, getCobolType, getDefaultValue, getDependingOn, getFractionDigits, getLevelNumber, getMarshalChoiceStrategyClassName, getMaxOccurs, getMinOccurs, getPicture, getRedefines, getSrceLine, getTotalDigits, getUnmarshalChoiceStrategyClassName, getUsage, isCustomVariable, isJustifiedRight, isODOObject, isRedefined, isSigned, isSignLeading, isSignSeparate, setByteLength, setCobolName, setCobolType, setDefaultValue, setDependingOn, setFractionDigits, setIsCustomVariable, setIsJustifiedRight, setIsODOObject, setIsRedefined, setIsSigned, setIsSignLeading, setIsSignSeparate, setLevelNumber, setMarshalChoiceStrategyClassName, setMaxOccurs, setMinOccurs, setPicture, setRedefines, setSrceLine, setTotalDigits, setUnmarshalChoiceStrategyClassName, setUsage

Method Detail

createJaxbObject

void createJaxbObject()
                      throws HostException

Deprecated. Requests array to create a JAXB complex array. Since bindings can now be bound to arbitrary value objects, use method createValueObject instead of this one.

Throws:

HostException - if initialization fails

createValueObject

void createValueObject()
                       throws HostException

Requests array to create a complex value array.

Throws:

HostException - if initialization fails

setItemValue

void setItemValue(int index)
                  throws HostException

Requests complex array binding to set its item values from the JAXB item identified by index.

Parameters:

index - identifies which item to set values for

Throws:

HostException - if reading from bound item values fails

addJaxbPropertyValue

void addJaxbPropertyValue(int index)
                          throws HostException

Deprecated. Request complex binding item to add a value to a jaxb bound object of the List type. The value is taken at index index in this binding array of values. Since bindings can now be bound to arbitrary value objects, use method addPropertyValue

Parameters:

index - item index in this array.

Throws:

HostException - if bound object values cannot be set

addPropertyValue

void addPropertyValue(int index)
                      throws HostException

Request complex binding item to add a value to a bound value object of the List type. The value is taken at index index in this binding array of values.

Parameters:

index - item index in this array.

Throws:

HostException - if bound object values cannot be set

getComplexItemBinding

ICobolComplexBinding getComplexItemBinding()

Returns the complex binding used for items of this array.

Returns:

the items complex binding

getObjectList

List<?> getObjectList()

Returns:

the List of items

setObjectList

void setObjectList(List<?> list)

Parameters:

list - the items List to set

getValueObjectClassName

String getValueObjectClassName()

Complex bindings can be bound to JAXB objects or arbitrary POJOs jointly referred to as value objects. This property is the fully qualified java class name of the bound value object.

Returns:

the fully qualified bound value object class name

setValueObjectClassName

void setValueObjectClassName(String valueObjectClassName)

Parameters:

valueObjectClassName - the fully qualified bound value object class name to set

getValueObjectsFactoryClassName

String getValueObjectsFactoryClassName()

Optional factory class name used to create bound value objects. If null, value objects are assumed to have a no-argument constructor.

Returns:

the factory class name used to create bound value objects

setValueObjectsFactoryClassName

void setValueObjectsFactoryClassName(String valueObjectsFactoryClassName)

Parameters:

valueObjectsFactoryClassName - the factory class name used to create bound value objects to set