OutputWhen (Smart GWT EE API 14.0p (2026-01-20))

java.lang.Object
- java.lang.Enum<OutputWhen>
- - com.smartgwt.client.types.OutputWhen

All Implemented Interfaces:

ValueEnum, java.io.Serializable, java.lang.Comparable<OutputWhen>
```
public enum OutputWhen
extends java.lang.Enum<OutputWhen>
implements ValueEnum
```
The type of condition field must match in order to be fetched from underlying source of data and delivered the client.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`NEVER` Field is never delivered, unless explicitly included in `OperationBinding.outputs`.
`SINGLE` Field is delivered for a `fetch` operation by primary key or as cache sync data after `update` or `add` operations.
`WHENPRESENT` Field is delivered as cache sync data after `update` or `add` operations only if the client seems to already have it for that record, i.e.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getValue()`
`static OutputWhen`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static OutputWhen[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - NEVER
```
public static final OutputWhen NEVER
```
    Field is never delivered, unless explicitly included in OperationBinding.outputs.
    If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "never".
  - SINGLE
```
public static final OutputWhen SINGLE
```
    Field is delivered for a fetch operation by primary key or as cache sync data after update or add operations. In both cases single record is expected to be returned.
    If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "single".
  - WHENPRESENT
```
public static final OutputWhen WHENPRESENT
```
    Field is delivered as cache sync data after update or add operations only if the client seems to already have it for that record, i.e. it was present in submitted values.
    If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "whenPresent".
- Method Detail
  - values
```
public static OutputWhen[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (OutputWhen c : OutputWhen.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static OutputWhen valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getValue
```
public java.lang.String getValue()
```
    Specified by:
    
    getValue in interface ValueEnum

Enum OutputWhen

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NEVER

SINGLE

WHENPRESENT

Method Detail

values

valueOf

getValue