Validatable (Appian API)

All Known Implementing Classes:

ActivityClassParameter, ActivityReturnVariable, ProcessVariable, ProcessVariableInstance
```
public interface Validatable
```
Classes implementing this interface can be subjected to runtime validation. Generally, these classes are descendants of TypedVariable.

See Also:

TypedVariable

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MUTABLE_AT_DESIGNER_DISCRETION`
`static int`	`MUTABLE_BY_END_USER`
`static int`	`MUTABLE_NOT_BY_END_USER`
`static int`	`NULLABLE_ADMIN_AND_DESIGN` May not have a default value, but still required by the runtime user.
`static int`	`NULLABLE_BY_ALL` Not required at all.
`static int`	`NULLABLE_NOT_AT_ALL` Must have a default value, must have a value submitted by the runtime user.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAllMessages(java.util.List newMessages_)` Adds all of the messages in the given list to the collection of validation messages maintained by this object.
`void`	`addValidationMessage(java.lang.String message_)` Adds the given validation message to the collection maintained by this object.
`void`	`clearValidationMessages()` Clears the collection of validation messages accumulated by this object.
`int[]`	`getDetailedTypes()` Gets the type array of Appian Object(s) selected within the picker.
`java.lang.String`	`getFriendlyName()` Gets a name that can be shown to an end user.
`java.lang.Long`	`getInstanceType()` Retrieves the type id, which corresponds to a `Datatype`.
`java.lang.String`	`getKey()` Gets the name of this variable.
`int`	`getMultiple()` Does this object support a value that is an array?
`java.lang.Long`	`getMutable()` Determines whether this object can be modified by the user.
`java.lang.Long`	`getNullable()` Determines whether this object can be set to null, or an empty string.
`java.lang.Long`	`getType()` Deprecated. Use getInstanceType()
`java.util.List`	`getValidationMessages()` Retrieves the list of validation messages that have been added to this object by a validator.
`java.lang.Object`	`getValue()` Retrieves the value of this object.
`void`	`setDetailedTypes(int[] detailedTypes_)` See `getDetailedTypes()`.
`void`	`setInstanceType(java.lang.Long type_)` Sets the type id, which corresponds to a `Datatype`.
`void`	`setMultiple(int multiple_)` See `getMultiple()`.
`void`	`setValue(java.lang.Object value_)` See `getValue()`.

- Field Detail
  - NULLABLE_NOT_AT_ALL
```
static final int NULLABLE_NOT_AT_ALL
```
    Must have a default value, must have a value submitted by the runtime user.
    
    See Also:
    
    Constant Field Values
  - NULLABLE_BY_ALL
```
static final int NULLABLE_BY_ALL
```
    Not required at all.
    
    See Also:
    
    Constant Field Values
  - NULLABLE_ADMIN_AND_DESIGN
```
static final int NULLABLE_ADMIN_AND_DESIGN
```
    May not have a default value, but still required by the runtime user.
    
    See Also:
    
    Constant Field Values
  - MUTABLE_NOT_BY_END_USER
```
static final int MUTABLE_NOT_BY_END_USER
```
    See Also:
    
    Constant Field Values
  - MUTABLE_BY_END_USER
```
static final int MUTABLE_BY_END_USER
```
    See Also:
    
    Constant Field Values
  - MUTABLE_AT_DESIGNER_DISCRETION
```
static final int MUTABLE_AT_DESIGNER_DISCRETION
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getNullable
```
java.lang.Long getNullable()
```
    Determines whether this object can be set to null, or an empty string.
    
    Returns:
    
    One of the NULLABLE_XXX constants (defined by this interface) indicating the nullability of the object.
  - getMutable
```
java.lang.Long getMutable()
```
    Determines whether this object can be modified by the user.
    
    Returns:
    
    One of the MUTABLE_XXX constants defined by this interface.
  - getValue
```
java.lang.Object getValue()
```
    Retrieves the value of this object. This value is not the object itself, but rather the object being wrapped. Think of classes that implement this interface as wrappers for a smaller object, along with a bunch of metadata about the object. This method returns the wrapped object (generally a String or a Long), without the metadata.
    
    Returns:
    
    The object wrapped by the implementing class.
  - setValue
```
void setValue(java.lang.Object value_)
```
    See getValue().
  - getType
```
@Deprecated
java.lang.Long getType()
```
    Deprecated. Use getInstanceType()
    
    Retrieves the type of this object. The type is just metadata about the value property, and corresponds to one of the constants defined in TypedVariable.
    
    Returns:
    
    The type of the wrapped object.
    
    See Also:
    
    TypedVariable
  - getInstanceType
```
java.lang.Long getInstanceType()
```
    Retrieves the type id, which corresponds to a Datatype. Built-in datatype ids are defined in AppianType
    
    Returns:
    
    the type id
  - setInstanceType
```
void setInstanceType(java.lang.Long type_)
```
    Sets the type id, which corresponds to a Datatype. Built-in datatype ids are defined in AppianType
  - getValidationMessages
```
java.util.List getValidationMessages()
```
    Retrieves the list of validation messages that have been added to this object by a validator. These messages are Strings.
    
    Returns:
    
    A list of Strings representing the validation messages.
  - addValidationMessage
```
void addValidationMessage(java.lang.String message_)
```
    Adds the given validation message to the collection maintained by this object. All messages can be retrieved with getValidationMessages().
    
    Parameters:
    
    message_ - The validation message to add.
  - clearValidationMessages
```
void clearValidationMessages()
```
    Clears the collection of validation messages accumulated by this object. A subsequent call to getValidationMessages() will return an empty list, unless there are intervening calls to addValidationMessage().
  - addAllMessages
```
void addAllMessages(java.util.List newMessages_)
```
    Adds all of the messages in the given list to the collection of validation messages maintained by this object.
    
    Parameters:
    
    newMessages_ - A list of validation messages to add, each of which is a String .
    
    Throws:
    
    java.lang.NullPointerException - - if the specified collection is null
  - getKey
```
java.lang.String getKey()
```
    Gets the name of this variable. Variables are generally key/value bindings, with the added attribute of type. This is the key part of the binding.
    
    Returns:
    
    The key as a String.
  - getFriendlyName
```
java.lang.String getFriendlyName()
```
    Gets a name that can be shown to an end user. In most cases, this is no more complicated than getKey(). Some types of variables, however, have more descriptive text sitting around, and can return that. Basically, end users know about labels, not variable names.
    
    Returns:
    
    The friendly name of the variable as a String.
  - getMultiple
```
int getMultiple()
```
    Does this object support a value that is an array?
    
    Returns:
    
    TypedVariable.ALWAYS or TypedVariable.NEVER
  - setMultiple
```
void setMultiple(int multiple_)
```
    See getMultiple().
  - getDetailedTypes
```
int[] getDetailedTypes()
```
    Gets the type array of Appian Object(s) selected within the picker.
    
    Returns:
    
    Array of values of the selected objects.
    
    See Also:
    
    TypedVariable
  - setDetailedTypes
```
void setDetailedTypes(int[] detailedTypes_)
```
    See getDetailedTypes().

Interface Validatable

Field Summary

Method Summary

Field Detail

NULLABLE_NOT_AT_ALL

NULLABLE_BY_ALL

NULLABLE_ADMIN_AND_DESIGN

MUTABLE_NOT_BY_END_USER

MUTABLE_BY_END_USER

MUTABLE_AT_DESIGNER_DISCRETION

Method Detail

getNullable

getMutable

getValue

setValue

getType

getInstanceType

setInstanceType

getValidationMessages

addValidationMessage

clearValidationMessages

addAllMessages

getKey

getFriendlyName

getMultiple

setMultiple

getDetailedTypes

setDetailedTypes