org.objectweb.speedo.mim.api
Interface FetchPlan

All Known Implementing Classes:
SpeedoFetchPlan

public interface FetchPlan

Author:
Y.Bersihand

Field Summary
static java.lang.String ALL
           
static java.lang.String DEFAULT
           
static java.lang.String NONE
           
static java.lang.String VALUES
           
 
Method Summary
 FetchPlan addGroup(java.lang.String fetchGroupName)
          Add the fetchgroup to the set of active fetch groups
 int getFetchSize()
          Return the fetch size, or 0 if not set.
 java.util.Collection getGroups()
          Return the names of all active fetch groups.
 FetchPlan removeGroup(java.lang.String fetchGroupName)
          Remove the fetch group from the set active fetch groups.
 FetchPlan resetGroups()
          Remove all active groups and activate the default fetch group.
 FetchPlan setFetchSize(int fetchSize)
          Set the fetch size for large result set support.
 FetchPlan setGroups(java.util.Collection fetchGroupNames)
          Set a collection of groups.
 

Field Detail

DEFAULT

public static final java.lang.String DEFAULT
See Also:
Constant Field Values

ALL

public static final java.lang.String ALL
See Also:
Constant Field Values

VALUES

public static final java.lang.String VALUES
See Also:
Constant Field Values

NONE

public static final java.lang.String NONE
See Also:
Constant Field Values
Method Detail

addGroup

public FetchPlan addGroup(java.lang.String fetchGroupName)
Add the fetchgroup to the set of active fetch groups


removeGroup

public FetchPlan removeGroup(java.lang.String fetchGroupName)
Remove the fetch group from the set active fetch groups.


resetGroups

public FetchPlan resetGroups()
Remove all active groups and activate the default fetch group.


getGroups

public java.util.Collection getGroups()
Return the names of all active fetch groups.


setGroups

public FetchPlan setGroups(java.util.Collection fetchGroupNames)
Set a collection of groups.


setFetchSize

public FetchPlan setFetchSize(int fetchSize)
Set the fetch size for large result set support. Use 0 to unset.


getFetchSize

public int getFetchSize()
Return the fetch size, or 0 if not set.