com.ibm.websphere.projector
Interface FetchPlan

public interface FetchPlan

A FetchPlan object allows you to customize how to fetch relations. It can customize the maximum depth of the eager relations to be fetched.

Since:

WAS XD 6.1.0.5

Field Summary

static int

DEPTH_INFINITE The default maximum fetch depth.

Method Summary

int	getMaxFetchDepth() Get the maximum fetch depth of eager relationships to retrieve.
FetchPlan	setMaxFetchDepth(int depth) Set the maximum fetch depth of eager relationships to retrieve.

Field Detail

DEPTH_INFINITE

static final int DEPTH_INFINITE

The default maximum fetch depth. If the maximum fetch depth is set to DEPTH_INFINITE, eager relations of all levels will be fetched.

See Also:

Constant Field Values

Method Detail

setMaxFetchDepth

FetchPlan setMaxFetchDepth(int depth)

Set the maximum fetch depth of eager relationships to retrieve.

For example, if the maximum fetch depth is set to 1, then only the first-level eager relations will be fetched with the fetch operations. If it is set to 0, then no relations will be fetched.

By default the max fetch depth is DEPTH_INFINITE, which means eager relations of all levels will be fetched.

Parameters:

depth - the maximum fetch depth

getMaxFetchDepth

int getMaxFetchDepth()

Get the maximum fetch depth of eager relationships to retrieve.

Returns:

the maximum fetch depth of eager relationships to retrieve