jp.vmi.selenium.selenese.command

Interface ICommand

All Known Implementing Classes:

AbstractCommand, AddCollection, AddToCollection, Assertion, BuiltInCommand, CaptureEntirePageScreenshot, Command, Comment, Echo, EndFor, EndLoopImpl, EndWhile, GotoIf, Gotolabel, Highlight, Include, Label, Open, OpenWindow, Pause, Rollup, RunScript, SelectFrame, SetSpeed, SetTimeout, StartLoopImpl, StartMarker, Store, StoreFor, WaitForCondition, WaitForPageToLoad, While, WindowMaximize

public interface ICommand

Command interface.

Method Summary

Modifier and Type	Method and Description
void	addScreenshot(String path, String label) Add screenshot image.
String[]	convertLocators(String[] args) Convert locators from arguments.
Result	execute(Context context, String... curArgs) Execute the command.
String[]	getArguments() Get command arguments.
int	getIndex() Get index in selenese script file (1 origin).
String	getName() Get command name.
Result	getResult() Get the command result.
List<Screenshot>	getScreenshots() Get list of screenshot images.
String[]	getSource() Get source elements.
StartLoop	getStartLoop() Get beginning-of-loop command.
boolean	mayUpdateScreen() May the command update screen?
void	setStartLoop(StartLoop startLoop) Set beginning-of-loop command.

Method Detail

getSource

String[] getSource()

Get source elements.

Returns:

array of source elements. (always 3 elements)

getIndex

int getIndex()

Get index in selenese script file (1 origin).

Returns:

index.

getArguments

String[] getArguments()

Get command arguments.

Returns:

command arguments.

getName

String getName()

Get command name.

Returns:

command name.

convertLocators

String[] convertLocators(String[] args)

Convert locators from arguments.

Parameters:

args - the command arguments.

Returns:

converted locators.

mayUpdateScreen

boolean mayUpdateScreen()

May the command update screen?

Returns:

true if the command may update screen.

execute

Result execute(Context context,
               String... curArgs)

Execute the command.

Note: set the command result to testCase in this method.

Parameters:

context - Selenese Runner context.

curArgs - current arugments. (the variables in it are extracted)

Returns:

the command result.

getResult

Result getResult()

Get the command result.

Returns:

the command result.

setStartLoop

void setStartLoop(StartLoop startLoop)

Set beginning-of-loop command.

Parameters:

startLoop - beginning-of-loop command.

getStartLoop

StartLoop getStartLoop()

Get beginning-of-loop command.

Returns:

beginning-of-loop command.

addScreenshot

void addScreenshot(String path,
                   String label)

Add screenshot image.

Parameters:

path - image path.

label - image label.

getScreenshots

List<Screenshot> getScreenshots()

Get list of screenshot images.

Returns:

list of image path of sreenshot.