com.appperfect.devcommon.script.javaelement
Interface IWindow

All Superinterfaces:

IScript

public interface IWindow
extends IScript

A IWindow object which can be executed by IScriptEngine.executeWindow(window) method.

An object of this class is created using createWindow method of IScriptEngine. Once the object is created, all its properties should be initialized to proper values and then executed using IScriptEngine.

See Also:

IScriptEngine, IScriptEngine.createWindow(int id, String sWindowTitle, boolean bDialog), IScriptEngine.executeWindow(IWindow window)

Method Summary

void	addAttribute(java.lang.String sAttributeName, java.lang.String sAttributeValue, boolean bIgnore, boolean bValidate, java.lang.String testParameterName) Each Window has a set of attributes, which are used to find the desired window during execution This method is used to add a attribute to the window
boolean	assertComponentAttributeValue(int id, java.lang.String windowClassName, java.lang.String description, java.lang.String attributeName, java.lang.String attributeValue) Once the window task is executed, the child components can be validated using this method
IValidationResult	getValidationResult() Once the IUrl task is executed, detailed validation result can be fetched using this method.
boolean	isValidationSuccessful() Once the IUrl task is executed, this method returns the status of the validation carried out
void	setBreakPoint(boolean bBreakPoint) This method should be called to set a breakpoint before executing task.
void	setComponentFilePath(java.lang.String path) This is helpful for validation purpose to match the replayed window child components with the recorded one.
void	setImagePath(java.lang.String sImagePath) This is used to set the window's image path.
void	setTitle(java.lang.String sTitle) This method is used to set the window's title
void	setValidationSuccessful(boolean success) Once the IUrl task is executed, this method can be used to set the status of validation

Methods inherited from interface com.appperfect.devcommon.script.IScript

getReasonForFailure, isIgnored, isTaskSuccessful, isTaskTimedOut, setIgnored, setReasonForFailure, setTaskSuccessful, setTaskTimedout, setThinkTime, setTimeout

Method Detail

addAttribute

void addAttribute(java.lang.String sAttributeName,
                  java.lang.String sAttributeValue,
                  boolean bIgnore,
                  boolean bValidate,
                  java.lang.String testParameterName)

Each Window has a set of attributes, which are used to find the desired window during execution This method is used to add a attribute to the window

Parameters:

sAttributeName - name of the attribute

sAttributeValue - value of the attribute

bIgnore - true if this attribute should be ignored; false otherwise.

bValidate - true if this attribute should be validated; false otherwise.

testParameterName - name of the TestParameter if the attribute value is parameterized

assertComponentAttributeValue

boolean assertComponentAttributeValue(int id,
                                      java.lang.String windowClassName,
                                      java.lang.String description,
                                      java.lang.String attributeName,
                                      java.lang.String attributeValue)

Once the window task is executed, the child components can be validated using this method

Parameters:

id - id of the child component as specified in the component file

windowClassName - native class name for the window

description - description of the validation

attributeName - name of the attribute

attributeValue - value of the attribute to validate

Returns:

true if successful false otherwise

getValidationResult

IValidationResult getValidationResult()

Once the IUrl task is executed, detailed validation result can be fetched using this method.

Returns:

validation result

isValidationSuccessful

boolean isValidationSuccessful()

Once the IUrl task is executed, this method returns the status of the validation carried out

Returns:

true if the validation was successful; false otherwise

setBreakPoint

void setBreakPoint(boolean bBreakPoint)

This method should be called to set a breakpoint before executing task. In case breakpoint is set, test will wait for user's interruption before moving forward.

Parameters:

bBreakPoint - true if breakpoint should be set; false otherwise.

setComponentFilePath

void setComponentFilePath(java.lang.String path)

This is helpful for validation purpose to match the replayed window child components with the recorded one.

Parameters:

path - file path of the component when this task was recorded.

setImagePath

void setImagePath(java.lang.String sImagePath)

This is used to set the window's image path.

Parameters:

sImagePath - file path of the window's image saved on disk.

setTitle

void setTitle(java.lang.String sTitle)

This method is used to set the window's title

Parameters:

sTitle - title of the window

setValidationSuccessful

void setValidationSuccessful(boolean success)

Once the IUrl task is executed, this method can be used to set the status of validation

Parameters:

success - true if the validation is successful; false otherwise