/* 
 * SAND development/deployment environment
 * Copyright (C) 2002-2006  SAND Services Inc.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.sandev.TaskHeap.PlanCalculator;

/**
 * <p>The PlanCalculator calculates the timeEstimate for a plan.  You send
 * it a PlanRecalc, and it sends you back the plan with the time estimate 
 * filled in.  A website deployment will typically run one instance of 
 * this node to provide plan calculation support for all heap users.  A
 * standalone client application might run its own local instance of
 * this node to allow users to work through various scenarios without
 * updating the central heap. </p>
 *
 * <p>PlanComponents are updated separately.  There is no "locking" behavior
 * for plans, and recalculation is done off of the data retrieved at the 
 * time.  Transaction locking is optimistic. </p>
 *
 * @sand.implements IDLookupPeer
 *
 * @sand.receive 
 *    org.sandev.TaskHeap.sandmessages.PlanRecalc
 *    org.sandev.TaskHeap.sandmessages.PlanRecalc
 * @sand.call
 *    org.sandev.TaskHeap.sandmessages.PlanQuery
 *    org.sandev.TaskHeap.sandmessages.PlanCollection
 *    planQuery
 * @sand.call
 *    org.sandev.TaskHeap.sandmessages.TaskQuery
 *    org.sandev.TaskHeap.sandmessages.TaskCollection
 *    taskQuery
 * @sand.call
 *    org.sandev.TaskHeap.sandmessages.ExternalPlanQuery
 *    org.sandev.TaskHeap.sandmessages.ExternalPlanCollection
 *    externalPlanQuery
 * @sand.call
 *    org.sandev.basics.sandmessages.Ping
 *    org.sandev.basics.sandmessages.Ping
 *    updaterNode
 * @sand.send
 *    org.sandev.TaskHeap.sandmessages.Plan
 */
public class PlanCalculatorNodeDecl
{

    /**
     * When recalculating a plan, the calculator walks the tree of
     * plan components starting from the given plan.  It is often
     * unnecessary to recurse the entire depth of the tree, if a plan
     * component is owned by somebody else, then it is typically their
     * responsibility to update it.  The default recursion setting stops
     * when it encounters a Plan that is owned by someone else.
     * 
     * <p>If a plan component is not owned, then it is included as part
     * of the calculation for its immediately containing plan, according
     * to the current top level plan being calculated. </p>
     *
     * @sand.enumint OWNER 0 "owner"
     * @sand.enumint FULL 1 "full"
     *
     * @sand.default FULL
     */
    public int recursionLevel;


    /**
     * The instance name of a local node that implements IDLookup.  We
     * use this to retrieve plan component information not passed in
     * during computation.
     */
    public String peerIDLookupNode;

}