Package org.bonitasoft.web.client.model

Class ActivityVariable

java.lang.Object

org.bonitasoft.web.client.model.ActivityVariable

All Implemented Interfaces:

Serializable

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class ActivityVariable
extends Object
implements Serializable

This resource enables you to retrieve the value of a specific variable name for a specific process instance (or case). Only persistent variables are concerned by this resource, not transient variables.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ActivityVariable.ContainerTypeEnum	ACTIVITY_INSTANCE | PROCESS_INSTANCE depending on whether the variable is defined at activity or process level.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_CLASS_NAME
static String	JSON_PROPERTY_CONTAINER_ID
static String	JSON_PROPERTY_CONTAINER_ID_STRING
static String	JSON_PROPERTY_CONTAINER_TYPE
static String	JSON_PROPERTY_DESCRIPTION
static String	JSON_PROPERTY_ID
static String	JSON_PROPERTY_ID_STRING
static String	JSON_PROPERTY_NAME
static String	JSON_PROPERTY_TENANT_ID
static String	JSON_PROPERTY_TENANT_ID_STRING
static String	JSON_PROPERTY_TRANSIENT_DATA
static String	JSON_PROPERTY_VALUE

Constructor Summary

Constructors

Constructor	Description
ActivityVariable()

Method Summary

Modifier and Type	Method	Description
ActivityVariable	className(String className)
ActivityVariable	containerId(String containerId)
ActivityVariable	containerIdString(String containerIdString)
ActivityVariable	containerType(ActivityVariable.ContainerTypeEnum containerType)
ActivityVariable	description(String description)
boolean	equals(Object o)
String	getClassName()	The fully qualified class name of the variable type
String	getContainerId()	The ID of the activity containing this variable (same as the one passed as parameter) if the variable is defined at activity level or ID of the process instance if the variable is defined on the process
String	getContainerIdString()	number (since 7.0.1)
ActivityVariable.ContainerTypeEnum	getContainerType()	ACTIVITY_INSTANCE | PROCESS_INSTANCE depending on whether the variable is defined at activity or process level.
String	getDescription()	The description of the variable if any
String	getId()	The identifier of the variable
String	getIdString()	number (since 7.0.1)
String	getName()	The name of the activity variable
String	getTenantId()	The ID of the tenant where the current user is logged in (technical information)
String	getTenantIdString()	number (since 7.0.1)
String	getTransientData()	FALSE
String	getValue()	the value of this variable.
int	hashCode()
ActivityVariable	id(String id)
ActivityVariable	idString(String idString)
ActivityVariable	name(String name)
void	setClassName(String className)
void	setContainerId(String containerId)
void	setContainerIdString(String containerIdString)
void	setContainerType(ActivityVariable.ContainerTypeEnum containerType)
void	setDescription(String description)
void	setId(String id)
void	setIdString(String idString)
void	setName(String name)
void	setTenantId(String tenantId)
void	setTenantIdString(String tenantIdString)
void	setTransientData(String transientData)
void	setValue(String value)
ActivityVariable	tenantId(String tenantId)
ActivityVariable	tenantIdString(String tenantIdString)
String	toString()
ActivityVariable	transientData(String transientData)
ActivityVariable	value(String value)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_TENANT_ID

public static final String JSON_PROPERTY_TENANT_ID

See Also:

Constant Field Values

JSON_PROPERTY_TENANT_ID_STRING

public static final String JSON_PROPERTY_TENANT_ID_STRING

See Also:

Constant Field Values

JSON_PROPERTY_ID

public static final String JSON_PROPERTY_ID

See Also:

Constant Field Values

JSON_PROPERTY_ID_STRING

public static final String JSON_PROPERTY_ID_STRING

See Also:

Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

Constant Field Values

JSON_PROPERTY_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

Constant Field Values

JSON_PROPERTY_TRANSIENT_DATA

public static final String JSON_PROPERTY_TRANSIENT_DATA

See Also:

Constant Field Values

JSON_PROPERTY_CLASS_NAME

public static final String JSON_PROPERTY_CLASS_NAME

See Also:

Constant Field Values

JSON_PROPERTY_CONTAINER_ID

public static final String JSON_PROPERTY_CONTAINER_ID

See Also:

Constant Field Values

JSON_PROPERTY_CONTAINER_ID_STRING

public static final String JSON_PROPERTY_CONTAINER_ID_STRING

See Also:

Constant Field Values

JSON_PROPERTY_CONTAINER_TYPE

public static final String JSON_PROPERTY_CONTAINER_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_VALUE

public static final String JSON_PROPERTY_VALUE

See Also:

Constant Field Values

Constructor Detail

ActivityVariable

public ActivityVariable()

Method Detail

tenantId

public ActivityVariable tenantId(String tenantId)

getTenantId

@Nullable
public String getTenantId()

The ID of the tenant where the current user is logged in (technical information)

Returns:

tenantId

setTenantId

public void setTenantId(String tenantId)

tenantIdString

public ActivityVariable tenantIdString(String tenantIdString)

getTenantIdString

@Nullable
public String getTenantIdString()

number (since 7.0.1)

Returns:

tenantIdString

setTenantIdString

public void setTenantIdString(String tenantIdString)

id

public ActivityVariable id(String id)

getId

@Nullable
public String getId()

The identifier of the variable

Returns:

id

setId

public void setId(String id)

idString

public ActivityVariable idString(String idString)

getIdString

@Nullable
public String getIdString()

number (since 7.0.1)

Returns:

idString

setIdString

public void setIdString(String idString)

name

public ActivityVariable name(String name)

getName

@Nullable
public String getName()

The name of the activity variable

Returns:

name

setName

public void setName(String name)

description

public ActivityVariable description(String description)

getDescription

@Nullable
public String getDescription()

The description of the variable if any

Returns:

description

setDescription

public void setDescription(String description)

transientData

public ActivityVariable transientData(String transientData)

getTransientData

@Nullable
public String getTransientData()

FALSE

Returns:

transientData

setTransientData

public void setTransientData(String transientData)

className

public ActivityVariable className(String className)

getClassName

@Nullable
public String getClassName()

The fully qualified class name of the variable type

Returns:

className

setClassName

public void setClassName(String className)

containerId

public ActivityVariable containerId(String containerId)

getContainerId

@Nullable
public String getContainerId()

The ID of the activity containing this variable (same as the one passed as parameter) if the variable is defined at activity level or ID of the process instance if the variable is defined on the process

Returns:

containerId

setContainerId

public void setContainerId(String containerId)

containerIdString

public ActivityVariable containerIdString(String containerIdString)

getContainerIdString

@Nullable
public String getContainerIdString()

number (since 7.0.1)

Returns:

containerIdString

setContainerIdString

public void setContainerIdString(String containerIdString)

containerType

public ActivityVariable containerType(ActivityVariable.ContainerTypeEnum containerType)

getContainerType

@Nullable
public ActivityVariable.ContainerTypeEnum getContainerType()

ACTIVITY_INSTANCE | PROCESS_INSTANCE depending on whether the variable is defined at activity or process level.

Returns:

containerType

setContainerType

public void setContainerType(ActivityVariable.ContainerTypeEnum containerType)

value

public ActivityVariable value(String value)

getValue

@Nullable
public String getValue()

the value of this variable. The format of the value depends on the type of the variable

Returns:

value

setValue

public void setValue(String value)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object