jp.vmi.selenium.selenese.command.ICommand Maven / Gradle / Ivy

package jp.vmi.selenium.selenese.command;

import java.util.List;

import jp.vmi.selenium.selenese.Context;
import jp.vmi.selenium.selenese.result.Result;

/**
 * Command interface.
 */
public interface ICommand {

    /**
     * Get source elements.
     *
     * @return array of source elements. (always 3 elements)
     */
    String[] getSource();

    /**
     * Get index in selenese script file (1 origin).
     *
     * @return index.
     */
    int getIndex();

    /**
     * Get command arguments.
     *
     * @return command arguments.
     */
    String[] getArguments();

    /**
     * Get command name.
     *
     * @return command name.
     */
    String getName();

    /**
     * Convert locators from arguments.
     *
     * @param args the command arguments.
     * @return converted locators.
     */
    String[] convertLocators(String[] args);

    /**
     * May the command update screen?
     *
     * @return true if the command may update screen.
     */
    boolean mayUpdateScreen();

    /**
     * Execute the command.
     * 
     * Note: set the command result to testCase in this method.
     * 
     *
     * @param context Selenese Runner context.
     * @param curArgs current arugments. (the variables in it are extracted)
     * @return the command result.
     */
    Result execute(Context context, String... curArgs);

    /**
     * Get the command result.
     *
     * @return the command result.
     */
    Result getResult();

    /**
     * Set beginning-of-loop command.
     *
     * @param startLoop beginning-of-loop command.
     */
    void setStartLoop(StartLoop startLoop);

    /**
     * Get beginning-of-loop command.
     *
     * @return beginning-of-loop command.
     */
    StartLoop getStartLoop();

    /**
     * Add screenshot image.
     *
     * @param path image path.
     */
    void addScreenshot(String path);

    /**
     * Get list of screenshot images.
     *
     * @return list of image path of sreenshot.
     */
    List getScreenshots();
}