InMemoryQueryIndirectionPolicy (EclipseLink 2.6.0, API Reference)

java.lang.Object
- org.eclipse.persistence.queries.InMemoryQueryIndirectionPolicy

All Implemented Interfaces:

java.io.Serializable
```
public class InMemoryQueryIndirectionPolicy
extends java.lang.Object
implements java.io.Serializable
```
Purpose: Provide a means of controlling the behavior of in-memory and conforming queries that access un-instantiated indirection objects in processing the query against cached objects.
Description: This class defines the valid constant values for handling in-memory querying. The constants should be set into the query's inMemoryQueryIndirectionPolicy.

See Also:
Serialized Form
Author:

Gordon Yorke

Since:

TopLink/Java 3.6.3

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`policy`
`protected ObjectLevelReadQuery`	`query` Used to set the policy state in the query.
`static int`	`SHOULD_IGNORE_EXCEPTION_RETURN_CONFORMED` If a non-instantiated indirection object is encountered the object is assumed to conform.
`static int`	`SHOULD_IGNORE_EXCEPTION_RETURN_NOT_CONFORMED` If a non-instantiated indirection object is encountered the object is assumed to not conform.
`static int`	`SHOULD_THROW_INDIRECTION_EXCEPTION` If a non-instantiated indirection object is encountered an exception is thrown.
`static int`	`SHOULD_TRIGGER_INDIRECTION` If a non-instantiated indirection object is encountered an exception it is instantiated.

Constructor Summary

Constructors
Constructor and Description
`InMemoryQueryIndirectionPolicy()`
`InMemoryQueryIndirectionPolicy(int policyValue)`
`InMemoryQueryIndirectionPolicy(int policy, ObjectLevelReadQuery query)`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getPolicy()`
`ObjectLevelReadQuery`	`getQuery()` INTERNAL: Return the query.
`void`	`ignoreIndirectionExceptionReturnConformed()`
`void`	`ignoreIndirectionExceptionReturnNotConformed()`
`void`	`setPolicy(int policy)`
`void`	`setQuery(ObjectLevelReadQuery query)` INTERNAL: Set the query.
`boolean`	`shouldIgnoreIndirectionExceptionReturnConformed()`
`boolean`	`shouldIgnoreIndirectionExceptionReturnNotConformed()`
`boolean`	`shouldThrowIndirectionException()`
`boolean`	`shouldTriggerIndirection()`
`void`	`throwIndirectionException()`
`void`	`triggerIndirection()`

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

- Field Detail
  - SHOULD_THROW_INDIRECTION_EXCEPTION
```
public static final int SHOULD_THROW_INDIRECTION_EXCEPTION
```
    If a non-instantiated indirection object is encountered an exception is thrown.
    
    See Also:
    Constant Field Values
  - SHOULD_TRIGGER_INDIRECTION
```
public static final int SHOULD_TRIGGER_INDIRECTION
```
    If a non-instantiated indirection object is encountered an exception it is instantiated. Caution should be used in using this option.
    
    See Also:
    Constant Field Values
  - SHOULD_IGNORE_EXCEPTION_RETURN_CONFORMED
```
public static final int SHOULD_IGNORE_EXCEPTION_RETURN_CONFORMED
```
    If a non-instantiated indirection object is encountered the object is assumed to conform.
    
    See Also:
    Constant Field Values
  - SHOULD_IGNORE_EXCEPTION_RETURN_NOT_CONFORMED
```
public static final int SHOULD_IGNORE_EXCEPTION_RETURN_NOT_CONFORMED
```
    If a non-instantiated indirection object is encountered the object is assumed to not conform.
    
    See Also:
    Constant Field Values
  - policy
```
protected int policy
```
  - query
```
protected ObjectLevelReadQuery query
```
    Used to set the policy state in the query.
- Constructor Detail
  - InMemoryQueryIndirectionPolicy
```
public InMemoryQueryIndirectionPolicy()
```
  - InMemoryQueryIndirectionPolicy
```
public InMemoryQueryIndirectionPolicy(int policyValue)
```
  - InMemoryQueryIndirectionPolicy
```
public InMemoryQueryIndirectionPolicy(int policy,
                              ObjectLevelReadQuery query)
```
- Method Detail
  - shouldTriggerIndirection
```
public boolean shouldTriggerIndirection()
```
  - shouldThrowIndirectionException
```
public boolean shouldThrowIndirectionException()
```
  - shouldIgnoreIndirectionExceptionReturnConformed
```
public boolean shouldIgnoreIndirectionExceptionReturnConformed()
```
  - shouldIgnoreIndirectionExceptionReturnNotConformed
```
public boolean shouldIgnoreIndirectionExceptionReturnNotConformed()
```
  - ignoreIndirectionExceptionReturnNotConformed
```
public void ignoreIndirectionExceptionReturnNotConformed()
```
  - ignoreIndirectionExceptionReturnConformed
```
public void ignoreIndirectionExceptionReturnConformed()
```
  - triggerIndirection
```
public void triggerIndirection()
```
  - throwIndirectionException
```
public void throwIndirectionException()
```
  - getPolicy
```
public int getPolicy()
```
  - setPolicy
```
public void setPolicy(int policy)
```
  - getQuery
```
public ObjectLevelReadQuery getQuery()
```
    INTERNAL: Return the query.
  - setQuery
```
public void setQuery(ObjectLevelReadQuery query)
```
    INTERNAL: Set the query.

Class InMemoryQueryIndirectionPolicy

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SHOULD_THROW_INDIRECTION_EXCEPTION

SHOULD_TRIGGER_INDIRECTION

SHOULD_IGNORE_EXCEPTION_RETURN_CONFORMED

SHOULD_IGNORE_EXCEPTION_RETURN_NOT_CONFORMED

policy

query

Constructor Detail

InMemoryQueryIndirectionPolicy

InMemoryQueryIndirectionPolicy

InMemoryQueryIndirectionPolicy

Method Detail

shouldTriggerIndirection

shouldThrowIndirectionException

shouldIgnoreIndirectionExceptionReturnConformed

shouldIgnoreIndirectionExceptionReturnNotConformed

ignoreIndirectionExceptionReturnNotConformed

ignoreIndirectionExceptionReturnConformed

triggerIndirection

throwIndirectionException

getPolicy

setPolicy

getQuery

setQuery