com.thingworx.metadata.annotations

Annotation Type ThingworxFieldDefinition

@Target(value=ANNOTATION_TYPE)
 @Retention(value=RUNTIME)
 @ThingworxExtensionApiAnnotation(since={6,6})
public @interface ThingworxFieldDefinition

A field definition describes a single field within a data shape definition. It is identical in composition to field definitions for data shape entities.

See Also:

FieldDefinition

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	baseType Required parameter: the base type for the field.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	aspects Optional parameter: an array of key-value pairs associated with colons (e.g., "aspect1:value1", "aspect2:value2", …) describing aspects applicable to the field definition.
java.lang.String	category Optional parameter: this parameter is currently ignored by the Platform.
java.lang.String	description Optional parameter: a short description for the field.
java.lang.String	name Required parameter: the name of the field.
int	ordinal Optional parameter: controls the order in which the fields should be rendered.

Element Detail

baseType

public abstract java.lang.String baseType

Required parameter: the base type for the field. The base type should be identical to one of the enumerations in the BaseTypes class. The base type must be specified in all caps.

name

public abstract java.lang.String name

Required parameter: the name of the field. Field names should follow ThingWorx entity naming conventions.

Default:

""

description

public abstract java.lang.String description

Optional parameter: a short description for the field.

Default:

""

category

public abstract java.lang.String category

Optional parameter: this parameter is currently ignored by the Platform.

Default:

""

ordinal

public abstract int ordinal

Optional parameter: controls the order in which the fields should be rendered. Any non-negative integer is permitted, where lower values take higher precedence over larger values. If several fields share the same ordinal, then the order is non-deterministic. Some widgets may also honor the ordinal value.

Default:

0

aspects

public abstract java.lang.String[] aspects

Optional parameter: an array of key-value pairs associated with colons (e.g., "aspect1:value1", "aspect2:value2", …) describing aspects applicable to the field definition.

See Also:

Aspects

Default:

{}