Package org.bonitasoft.web.client.model

Class 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

    • Constructor Detail

      • ActivityVariable

        public ActivityVariable()

    • Method Detail

      • 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)

      • getTenantIdString

        @Nullable
public String getTenantIdString()
        number (since 7.0.1)
        Returns:
        tenantIdString

      • setTenantIdString

        public void setTenantIdString​(String tenantIdString)

      • getId

        @Nullable
public String getId()
        The identifier of the variable
        Returns:
        id

      • setId

        public void setId​(String id)

      • getIdString

        @Nullable
public String getIdString()
        number (since 7.0.1)
        Returns:
        idString

      • setIdString

        public void setIdString​(String idString)

      • getName

        @Nullable
public String getName()
        The name of the activity variable
        Returns:
        name

      • setName

        public void setName​(String name)

      • getDescription

        @Nullable
public String getDescription()
        The description of the variable if any
        Returns:
        description

      • setDescription

        public void setDescription​(String description)

      • getTransientData

        @Nullable
public String getTransientData()
        FALSE
        Returns:
        transientData

      • setTransientData

        public void setTransientData​(String transientData)

      • getClassName

        @Nullable
public String getClassName()
        The fully qualified class name of the variable type
        Returns:
        className

      • setClassName

        public void setClassName​(String className)

      • 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)

      • getContainerIdString

        @Nullable
public String getContainerIdString()
        number (since 7.0.1)
        Returns:
        containerIdString

      • setContainerIdString

        public void setContainerIdString​(String containerIdString)

      • getContainerType

        @Nullable
public ActivityVariable.ContainerTypeEnum getContainerType()
        ACTIVITY_INSTANCE | PROCESS_INSTANCE depending on whether the variable is defined at activity or process level.
        Returns:
        containerType

      • 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)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object