/* 
 * SAND development/deployment environment
 * Copyright (C) 2003-2005  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.TaskHeapUI;

/**
 * The TaskHeapUI serves as the access point for all messages in and out
 * of the system.  A servlet or other UI adaptor can call the methods in
 * this node directly to communicate with the main application.
 *
 * @sand.implements AuthUserPeer IDLookup MailSender
 *
 * @sand.call
 *    org.sandev.basics.sandmessages.AggregateUpdate
 *    org.sandev.basics.sandmessages.AggregateUpdate
 *    aggregateUpdate
 *
 * @sand.call
 *    org.sandev.TaskHeap.sandmessages.ExternalPlanQuery
 *    org.sandev.TaskHeap.sandmessages.ExternalPlanCollection
 *    externalPlanQuery
 * @sand.receive
 *    org.sandev.TaskHeap.sandmessages.ExternalPlanQuery
 *    org.sandev.TaskHeap.sandmessages.ExternalPlanCollection
 * @sand.receive
 *    org.sandev.TaskHeap.sandmessages.ExternalPlanUpdate
 *    org.sandev.TaskHeap.sandmessages.ExternalPlanUpdate
 *
 * @sand.call
 *    org.sandev.TaskHeap.sandmessages.ExternalPlanSync
 *    org.sandev.TaskHeap.sandmessages.ExternalPlanSync
 *    externalPlanSync
 * @sand.receive
 *    org.sandev.TaskHeap.sandmessages.ExternalPlanSync
 *    org.sandev.TaskHeap.sandmessages.ExternalPlanSync
 * 
 * @sand.call
 *    org.sandev.TaskHeap.sandmessages.PlanComponentQuery
 *    org.sandev.TaskHeap.sandmessages.PlanComponentCollection
 *    planComponentQuery
 *
 * @sand.call
 *    org.sandev.TaskHeap.sandmessages.PlanQuery
 *    org.sandev.TaskHeap.sandmessages.PlanCollection
 *    planQuery
 * @sand.receive
 *    org.sandev.TaskHeap.sandmessages.PlanQuery
 *    org.sandev.TaskHeap.sandmessages.PlanCollection
 * @sand.receive
 *    org.sandev.TaskHeap.sandmessages.PlanUpdate
 *    org.sandev.TaskHeap.sandmessages.PlanUpdate
 *
 * @sand.call
 *    org.sandev.TaskHeap.sandmessages.TaskPhaseQuery
 *    org.sandev.TaskHeap.sandmessages.TaskPhaseCollection
 *    taskPhaseQuery
 * @sand.receive
 *    org.sandev.TaskHeap.sandmessages.TaskPhaseQuery
 *    org.sandev.TaskHeap.sandmessages.TaskPhaseCollection
 * 
 * @sand.call
 *    org.sandev.TaskHeap.sandmessages.TaskQuery
 *    org.sandev.TaskHeap.sandmessages.TaskCollection
 *    taskQuery
 * @sand.receive
 *    org.sandev.TaskHeap.sandmessages.TaskQuery
 *    org.sandev.TaskHeap.sandmessages.TaskCollection
 * @sand.receive
 *    org.sandev.TaskHeap.sandmessages.TaskUpdate
 *    org.sandev.TaskHeap.sandmessages.TaskUpdate
 *
 * @sand.call
 *    org.sandev.TaskHeap.sandmessages.TaskTypeQuery
 *    org.sandev.TaskHeap.sandmessages.TaskTypeCollection
 *    taskTypeQuery
 * @sand.receive
 *    org.sandev.TaskHeap.sandmessages.TaskTypeQuery
 *    org.sandev.TaskHeap.sandmessages.TaskTypeCollection
 *
 * @sand.call 
 *     org.sandev.basics.sandmessages.CacheAction
 *     org.sandev.basics.sandmessages.CacheAction
 *     cacheActionRegistration
 * @sand.call 
 *     org.sandev.basics.sandmessages.StatsQuery
 *     org.sandev.basics.sandmessages.Stats
 *     statsQuery
 *
 * @sand.call 
 *     org.sandev.TaskHeap.sandmessages.HeapAttributesQuery
 *     org.sandev.TaskHeap.sandmessages.HeapAttributesCollection
 *     heapAttributesQuery
 * @sand.receive
 *     org.sandev.TaskHeap.sandmessages.HeapAttributesQuery
 *     org.sandev.TaskHeap.sandmessages.HeapAttributesCollection
 *
 * @sand.call 
 *     org.sandev.TaskHeap.sandmessages.AccountQuery
 *     org.sandev.TaskHeap.sandmessages.AccountCollection
 *     accountQuery
 * @sand.receive
 *     org.sandev.TaskHeap.sandmessages.AccountQuery
 *     org.sandev.TaskHeap.sandmessages.AccountCollection
 * @sand.receive
 *     org.sandev.TaskHeap.sandmessages.AccountUpdate
 *     org.sandev.TaskHeap.sandmessages.AccountUpdate
 *
 * @sand.call 
 *     org.sandev.TaskHeap.sandmessages.HeapAssociationQuery
 *     org.sandev.TaskHeap.sandmessages.HeapAssociationCollection
 *     heapAssociationQuery
 *
 * @sand.call 
 *     org.sandev.TaskHeap.sandmessages.SystemStatusQuery
 *     org.sandev.TaskHeap.sandmessages.SystemStatusCollection
 *     systemStatusQuery
 * @sand.receive
 *     org.sandev.TaskHeap.sandmessages.SystemStatusQuery
 *     org.sandev.TaskHeap.sandmessages.SystemStatusCollection
 *
 * @sand.call 
 *     org.sandev.TaskHeap.sandmessages.DataManagementQuery
 *     org.sandev.TaskHeap.sandmessages.DataManagementCollection
 *     dataManagementQuery
 *
 * @sand.call 
 *     org.sandev.TaskHeap.sandmessages.RoleQuery
 *     org.sandev.TaskHeap.sandmessages.RoleCollection
 *     roleQuery
 * @sand.receive
 *     org.sandev.TaskHeap.sandmessages.RoleQuery
 *     org.sandev.TaskHeap.sandmessages.RoleCollection
 *
 * @sand.call 
 *     org.sandev.TaskHeap.sandmessages.HeapDisplay
 *     org.sandev.TaskHeap.sandmessages.HeapDisplay
 *     heapDisplay
 *
 * @sand.call 
 *     org.sandev.basics.sandmessages.DataImportExport
 *     org.sandev.basics.sandmessages.DataImportExport
 *     dataImportExport
 * @sand.subscribe
 *     org.sandev.basics.sandmessages.CacheAction
 *     cacheActionSource
 * @sand.subscribe
 *     org.sandev.basics.sandmessages.Stats
 *     statsSource
 */
public class TaskHeapUINodeDecl
{

    /**
     * The instance name of our UserLookup node.  We rely on this local
     * node to implement the AuthUserLookup part of the UIFormOwner 
     * interface.
     *
     * @sand.stringlength 30 60
     */
    protected String peerAuthUserLookupNode;


    /**
     * The instance name of our Authorizer node.  We rely on this local
     * node to retrieve an AuthFilter instance for use.
     *
     * @sand.stringlength 30 60
     */
    protected String authorizerInstanceName;


    /**
     * The directory used for uploaded import files.
     *
     * @sand.stringlength 30 60
     * @sand.default "TaskHeap/import"
     */
    protected String inputFileDir;


    /**
     * The directory used for generated reports and other output.
     *
     * @sand.stringlength 30 60
     * @sand.default "TaskHeap/output"
     */
    protected String outputFileDir;


    /**
     * The email address for tech support.
     *
     * @sand.stringlength 30 60
     * @sand.default "support@taskheap.com"
     */
    protected String techSupportEmailAddress;


    /**
     * The name of the internal node communications user, used to disallow
     * login as this user.
     *
     * @sand.stringlength 30 60
     * @sand.default "InternalComms"
     */
    protected String internalCommsUsername;


    /**
     * The name of the recalc batch user, used to disallow login.
     *
     * @sand.stringlength 30 60
     * @sand.default "recalc"
     */
    protected String recalcUsername;

}