CollectionSchemaField Class

class CollectionSchemaField

Namespace:datalogics_interface

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

CollectionSchema

Uses types

SchemaFieldSubtype

Constructor & Destructor Documentation

CollectionSchemaField(CollectionSchemaField && )

Parameters

: CollectionSchemaField &&

CollectionSchemaField(const std::string & field_id, SchemaFieldSubtype subtype)

Parameters

field_id: const std::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.

~CollectionSchemaField()

Member Function Documentation

bool get_editable()

Returns:

bool

whether edit mode is allowed or not.

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

std::string get_id()

Returns:

std::string

the unique field's id.

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

int get_index()

Returns:

int

the index of the field.

GetIndex allows to obtain field index.

std::string get_name()

Returns:

std::string

the field name.

GetName allows to obtain field name.

SchemaFieldSubtype get_subtype()

Returns:

SchemaFieldSubtype

field subtype. One of the ShemaFieldSubtype enum values.

GetSubtype allows to obtain the field subtype.

bool get_visible()

Returns:

bool

true if current schema field is visible, false otherwise.

GetVisible allows to obtain information about filed visibility.

CollectionSchemaField & operator=(CollectionSchemaField && )

Parameters

: CollectionSchemaField &&

Returns:

CollectionSchemaField &

void set_editable(bool editable)

Parameters

editable: bool: 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.

void set_index(int index)

Parameters

index: int: field index.

Returns:

void

SetIndex allows to set field index.

NOTE: the field indexes are zero-based in ascending order without gaps.

void set_name(const std::string & name)

Parameters

name: const std::string &: the new field name.

Returns:

void

SetName allows to change field name.

void set_visible(bool visible)

Parameters

visible: bool: the visibility flag.

Returns:

void

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