ConsoleMacro.java :  » Workflow-Engines » JFolder » org » jfolder » console » macro » Java Open Source

/*
 * JFolder, Copyright 2001-2006 Gary Steinmetz
 *
 * Distributable under LGPL license.
 * See terms of license at gnu.org.
 */

package org.jfolder.console.macro;

//base classes
import java.util.ArrayList;
import java.util.HashMap;

//project specific classes
import org.jfolder.common.tagging.ConceptTagHelper;
import org.jfolder.common.tagging.ConceptTagSetContext;
import org.jfolder.common.tagging.ConceptTagSetHolder;
import org.jfolder.common.tagging.RootConceptTagHolder;
import org.jfolder.common.utils.web.ParameterSet;
import org.jfolder.common.web.template.ConsoleTemplateSession;
import org.jfolder.common.web.template.PageSetupContext;

//other classes

public interface ConsoleMacro {
    
    //
    public void processRecordCommands(
        String inCommands, String inFromHandle, String inAliasFromHandle,
        String inSourName, String inDestName);
    //public void processRecordCommands(
    //    String inCommands, String inFromHandle, String inAliasFromHandle,
    //    String inSourName, String inDestName, String inTreeState);
    
    //
    public void reset(String inStartDesc, String inEndDesc, HashMap inVars);
    public void postIncrementCommand(RootConceptTagHolder inRcth);
    public void preIncrementCommand(RootConceptTagHolder inRcth);
    public void loadRcthConstraintBuilderIfPresent(
        PageSetupContext inPsc, RootConceptTagHolder inRcth);
    public boolean isDoneRunning();
    //public String getTreeState();
    public boolean isMacroReset();
    public void generateMacroCommands(
        PageSetupContext inPsc, ConsoleTemplateSession inCts,
        RootConceptTagHolder inRcth, HashMap inVars,
        String inFromHandle, String inAliasFromHandle,
        String inSourcePage, String inDestinationPage);
    public int getCurrentIndex();
    public int getMacroCommandCount();
    //
    public void addDescriptionToNextPage(String inDescription);
    public ArrayList getPageDescriptions();
    public int getPageIndexOfDescription(String inDesciption);
    public String getDescription(int inIndex);
    //
    public void initializeParameters(ParameterSet inPs);
    public void addParameterAsFileUpload(
        String inName, String inFileName, byte inContent[]);
    public void addParameterAsString(String inName, String inValue);
}