CollectionSchemaField Class Documentation

classCollectionSchemaField

Namespace:com::datalogics::PDFL

Detailed Description

Allows for the creation of collection schema field objects. Parameters that are part of a schema's field may be set.

Referenced by

CollectionSchemaFileAttachment

Constructor & Destructor Documentation

CollectionSchemaField

CollectionSchemaField(StringfieldID, SchemaFieldSubtypesubtype)

Parameters

fieldID: String

the schema field ID. The ID is used during creation and extraction of the schema field. It is the unique identifier of the schema field.

subtype: SchemaFieldSubtype

the schema field subtype. The subtypes are predefined. The value of this parameter must correspond to the one of the SchemaFieldSubtype enum values.

CCollectionSchemaField allows to create CollectionSchemaField object. The constructor accepts identifier value and subtype required by the schema field.

Member Function Documentation

DisposeChildren

voidDisposeChildren()

Returns:

void

[static initializer]

static void[static initializer]()

delete

synchronized voiddelete(Booleandisposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized voiddelete()

Returns:

synchronized void

finalize

voidfinalize()

Returns:

void

getEditable

booleangetEditable()

Returns:

whether edit mode is allowed or not.

GetEditable allows to obtain information about edit mode of the current field.

getID

StringgetID()

Returns:

the unique field's id.

GetID allows to obtain the unique id with which schema field has been created.

getIndex

intgetIndex()

Returns:

the index of the field.

GetIndex allows to obtain field index.

getName

StringgetName()

Returns:

the field name.

GetName allows to obtain field name.

getSubtype

SchemaFieldSubtypegetSubtype()

Returns:

field subtype. One of the ShemaFieldSubtype enum values.

GetSubtype allows to obtain the field subtype.

getVisible

booleangetVisible()

Returns:

true if current schema field is visible, false otherwise.

GetVisible allows to obtain information about filed visibility.

setEditable

voidsetEditable(booleanisEditable)

Parameters

isEditable: boolean

pass true to allow to edit this field or false otherwise.

Returns:

void

SetEditable allows to change edit mode for shema field.Its value false by default.

setIndex

voidsetIndex(intidx)

Parameters

idx: int

field index.

Returns:

void

SetIndex allows to set field index. NOTE: the field indexes are zero-based in ascending order without gaps.

setName

voidsetName(Stringname)

Parameters

name: String

the new field name.

Returns:

void

SetName allows to change field name.

setVisible

voidsetVisible(booleanisVisible)

Parameters

isVisible: boolean

the visibility flag.

Returns:

void

SetVisible allows to set field's default visibility.Its value true by default.