com.workfusion.vds.sdk.api.hypermodel.annotation

Annotation Type ModelDescription

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface ModelDescription

Class-level annotation that is used to define model description: code, version, title, description etc.

Since:

9.0.0

Author:

Heorhi Stsefanovich, Aliaksei Kushunin, Alexey Gaponik

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	code Model code.
String	description Model human-readable description.
String	title Model human-readable title.
String	version Model version.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
com.workfusion.vds.sdk.api.hypermodel.ModelType	type Model type.

Element Detail

code

public abstract String code

Model code. Must contain only a-z, 0-9 and '-'.

title

public abstract String title

Model human-readable title.

description

public abstract String description

Model human-readable description.

version

public abstract String version

Model version.

Model versions are compared using semantic versioning, i.e. version '10.0' is higher than '9.0' (although lexicographically '9' is higher than '1').

type

public abstract com.workfusion.vds.sdk.api.hypermodel.ModelType type

Model type.

See Also:

ModelType

Default:

com.workfusion.vds.sdk.api.hypermodel.ModelType.UNKNOWN