Content Engine Java API: RefreshMode

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- com.filenet.api.constants.RefreshMode

All Implemented Interfaces:

java.io.Serializable
```
public class RefreshMode
extends java.lang.Object
implements java.io.Serializable
```
Specifies whether to retrieve refreshed data from the Content Engine server for updating an object's property cache when the object is explicitly saved or is committed to the persistent store as part of a batch. Use this constant when calling methods that have a refresh parameter, such as save and createUpdatingBatchInstance. Depending on the parameters of the method being called, you can either refresh all of the object's properties or, by specifying a property filter, refresh a subset of the object's properties.
Note that you cannot refresh an object's property cache until the object has been created on the Content Engine server. Attempting to do so causes an API_SAVE_BEFORE_REFRESH exception to be thrown.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static RefreshMode`	`NO_REFRESH` Specifies that upon saving or committing the object, its property cache is not refreshed with updated data from the Content Engine server.
`static RefreshMode`	`REFRESH` Specifies that upon saving or committing the object, its property cache is refreshed with updated data from the Content Engine server.

Method Summary

Methods
Modifier and Type	Method and Description
`static RefreshMode`	`getInstanceFromInt(int value)` Gets an instance of this class using its associated integer value (the `*_AS_INT` fields).
`int`	`getValue()` Returns an integer value associated with a specific instance of this class.
`java.lang.String`	`toString()` Returns a `String` representation of this instance.

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

- Field Detail
  - REFRESH
```
public static final RefreshMode REFRESH
```
    Specifies that upon saving or committing the object, its property cache is refreshed with updated data from the Content Engine server. Specifying REFRESH synchronizes the object's properties with those in the persistent store.
  - NO_REFRESH
```
public static final RefreshMode NO_REFRESH
```
    Specifies that upon saving or committing the object, its property cache is not refreshed with updated data from the Content Engine server.
- Method Detail
  - getValue
```
public int getValue()
```
    Returns an integer value associated with a specific instance of this class.
    
    Returns:
    An integer representing a specific instance of this class.
  - getInstanceFromInt
```
public static RefreshMode getInstanceFromInt(int value)
```
    Gets an instance of this class using its associated integer value (the *_AS_INT fields).
    
    Parameters:
    value - An integer representing a particular static instance of this class.
    
    Returns:
    The referenced RefreshMode instance.
    
    Throws:
    
    EngineRuntimeException - Thrown when the value parameter is null or invalid.
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    A String representing the instance.