com.webmethods.caf.common.model

Interface IDocumentStructureProvider.IFieldInfo

All Known Subinterfaces:

JavaDocumentStructureBuilder.IJavaTypeFieldInfo

Enclosing interface:

IDocumentStructureProvider

public static interface IDocumentStructureProvider.IFieldInfo

Single document field information

Method Summary

Modifier and Type	Method and Description
IDocumentStructureProvider.IFieldInfo[]	getFields() If isComplexType() is true, return non empty array of fields.
String	getName() Field name.
String	getType() Type of the field.
boolean	isArray() Return true if this field is an array of getType() elements.
boolean	isComplexType() Return true if this field represents a complex type, i.e.
boolean	isReadOnly() Return true if this field is readonly

Method Detail

getName

String getName()

Field name. Must not be null

Returns:

field name

getType

String getType()

Type of the field. May return null if type is unknown or if isComplexType() is true. May return type from any type system. The client is responsible for mapping to the target type system.

Returns:

field type or null if unknown

isReadOnly

boolean isReadOnly()

Return true if this field is readonly

Returns:

false for writable fields

isComplexType

boolean isComplexType()

Return true if this field represents a complex type, i.e. a type that is constructed from other fields. In this case the client expects that the structure of this complex type is defined inplace, i.e. the client does not have any knowlendge how to de-reference the complex type automatically. It is the responsibility of the provider to make such resolution and provide non-empty getFields() array.

Returns:

false if getFields() returns null or empty array

isArray

boolean isArray()

Return true if this field is an array of getType() elements.

Returns:

false if getFields() returns null or empty array

getFields

IDocumentStructureProvider.IFieldInfo[] getFields()

If isComplexType() is true, return non empty array of fields.

Returns:

null for simple fields