org.eclipse.datatools.sqltools.plan.internal
Interface IPlanManager

All Known Implementing Classes:
PlanManager

public interface IPlanManager

Manages plan instances

Author:
Hui Cao

Method Summary
 void addPlanManagerListener(IPlanManagerListener listener)
          Adds listener
 IPlanInstance createNewPlanInstance(PlanRequest request)
          Creates a new plan instance
 IPlanInstance[] getAllPlanInstances()
          Returns all currently available plan instances
 IPlanInstance getPlanInstance(PlanRequest request)
          Returns the plan instance identified by given plan request
 void removeAllFinished()
          Removes all finished plan instances
 void removePlanInstance(IPlanInstance instance)
          Removes the specified plan instance
 void removePlanManagerListener(IPlanManagerListener listener)
          Removes listener
 

Method Detail

addPlanManagerListener

void addPlanManagerListener(IPlanManagerListener listener)
Adds listener

Parameters:
listener - a listener

createNewPlanInstance

IPlanInstance createNewPlanInstance(PlanRequest request)
Creates a new plan instance

Parameters:
request - the given plan request
Returns:
a new plan instance

getAllPlanInstances

IPlanInstance[] getAllPlanInstances()
Returns all currently available plan instances

Returns:
all available plan instances

removeAllFinished

void removeAllFinished()
Removes all finished plan instances


removePlanInstance

void removePlanInstance(IPlanInstance instance)
Removes the specified plan instance

Parameters:
instance - the specified plan instance

removePlanManagerListener

void removePlanManagerListener(IPlanManagerListener listener)
Removes listener

Parameters:
listener - a listener

getPlanInstance

IPlanInstance getPlanInstance(PlanRequest request)
Returns the plan instance identified by given plan request

Returns:
the plan instance identified by given plan request