File Doc Category Size Date Package
InMemoryQueryIndirectionPolicy.java API Doc Glassfish v2 API 4351 Tue May 22 16:54:50 BST 2007 oracle.toplink.essentials.queryframework

InMemoryQueryIndirectionPolicy

java.lang.Object

public class InMemoryQueryIndirectionPolicy extends Object implements Serializable

Purpose: Used to provide the user with a means of contoling the behaviour of in memory queries that access un-instantiated indirection in the query..

Description: This class contains a state variable that is used to determine what a query should do when accesing un-instantiated indirection. Use use this policy access the policy of a query set the policy behaviour using the methods below. All read queries have the policy set to throw exception by default

author: Gordon Yorke
since: TopLink/Java 3.6.3

Fields Summary
public static final int
SHOULD_THROW_INDIRECTION_EXCEPTION
public static final int
SHOULD_TRIGGER_INDIRECTION
public static final int
SHOULD_IGNORE_EXCEPTION_RETURN_CONFORMED
public static final int
SHOULD_IGNORE_EXCEPTION_RETURN_NOT_CONFORMED
protected int
policy
Constructors Summary
public InMemoryQueryIndirectionPolicy()
this.policy = SHOULD_THROW_INDIRECTION_EXCEPTION;
public InMemoryQueryIndirectionPolicy(int policyValue)
this.policy = policyValue;
Methods Summary
public int getPolicy()
return this.policy;
public void ignoreIndirectionExceptionReturnConformed()
this.policy = SHOULD_IGNORE_EXCEPTION_RETURN_CONFORMED;
public void ignoreIndirectionExceptionReturnNotConformed()
this.policy = SHOULD_IGNORE_EXCEPTION_RETURN_NOT_CONFORMED;
public void setPolicy(int policy)
this.policy = policy;
public boolean shouldIgnoreIndirectionExceptionReturnConformed()
return this.policy == SHOULD_IGNORE_EXCEPTION_RETURN_CONFORMED;
public boolean shouldIgnoreIndirectionExceptionReturnNotConformed()
return this.policy == SHOULD_IGNORE_EXCEPTION_RETURN_NOT_CONFORMED;
public boolean shouldThrowIndirectionException()
return this.policy == SHOULD_THROW_INDIRECTION_EXCEPTION;
public boolean shouldTriggerIndirection()
return this.policy == SHOULD_TRIGGER_INDIRECTION;
public void throwIndirectionException()
this.policy = SHOULD_THROW_INDIRECTION_EXCEPTION;
public void triggerIndirection()
this.policy = SHOULD_TRIGGER_INDIRECTION;