org.safs.model.commands

Class HTMLLinkFunctions

java.lang.Object

org.safs.model.commands.HTMLLinkFunctions

public class HTMLLinkFunctions
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLICK_KEYWORD "Click"
static java.lang.String	COMPARESTOREDDATA_KEYWORD "CompareStoredData"
static java.lang.String	COMPARESTOREDPROPERTIES_KEYWORD "CompareStoredProperties"

Method Summary

Modifier and Type	Method and Description
static ComponentFunction	click(java.lang.String winname, java.lang.String compname) Use Generic CLICK where possible.
static ComponentFunction	compareStoredData(java.lang.String winname, java.lang.String compname, java.lang.String vPAsset) Performs a HTMLLinkVP CompareData on an HTMLLink object.
static ComponentFunction	compareStoredProperties(java.lang.String winname, java.lang.String compname, java.lang.String vPAsset) Performs a HTMLLinkVP CompareProperties on an HTMLLink object.
static HTMLLinkFunctions	getInstance() public Singleton to access class static methods via instance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLICK_KEYWORD

public static final java.lang.String CLICK_KEYWORD

"Click"

See Also:

Constant Field Values

COMPARESTOREDDATA_KEYWORD

public static final java.lang.String COMPARESTOREDDATA_KEYWORD

"CompareStoredData"

See Also:

Constant Field Values

COMPARESTOREDPROPERTIES_KEYWORD

public static final java.lang.String COMPARESTOREDPROPERTIES_KEYWORD

"CompareStoredProperties"

See Also:

Constant Field Values

Method Detail

getInstance

public static HTMLLinkFunctions getInstance()

public Singleton to access class static methods via instance

click

public static ComponentFunction click(java.lang.String winname,
                                      java.lang.String compname)

 
                 Use Generic CLICK where possible.
               
                Attempts to perform a standard Click on an HTMLLink on a webpage.
                
                Example:
                
                BrowserWin SomeLink Click
                  

Supporting Engines:

• Mercury Interactive WinRunner

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

compareStoredData

public static ComponentFunction compareStoredData(java.lang.String winname,
                                                  java.lang.String compname,
                                                  java.lang.String vPAsset)

 
                Performs a HTMLLinkVP CompareData on an HTMLLink object.
               
                Performs a HTMLLinkVP CompareData on an HTMLLink object.
                
                THE BENCHMARK VP MUST ALREADY EXIST AND BE AN ASSET OF THE CURRENTLY
                RUNNING SCRIPT.
                 
                Modified VP parameter information can be added to the standard
                VP=VPName by including the VPName reference in the application map
                in a section defined for the HTMLLink.  If this is done, the value 
                retrieved from the application map will be appended to VP=VPName.
                The required semicolon for this append will be provided by this routine.
                
                Example 1: Perform a standard HTMLLink CompareData.  To perform
                a basic CompareData the name "StoredVP" will not exist in the app map:
                
                The Step File call:
                
                BrowserWindow AnHTMLLink CompareStoredData StoredVP
                
                This will produce a CompareData VP with "VP=StoredVP;Wait=2,10".
                
                The StoredVP baseline MUST already exist as an asset of the
                currently running script.
                
                Example 2: Perform a HTMLLink CompareData providing addition 
                parameter information (such as ExpectedResult=FAIL).  To do this the
                HTMLLink object must have its own section in the app map and an item
                with the same name as the StoredVP.  The value of that item will be
                appended to the standard VP argument with a semicolon.
                
                Part of App Map:
                
                [BrowserWindow]
                BrowserWindow=WindowTag=WEBBrowser
                AnHTMLLink=;\;Type=HTMLLink;HTMLID=LinkID
                ...
                [AnHTMLLink]
                StoredVP=ExpectedResult=FAIL;Wait=3,30
                 
                The Step File call:
                
                BrowserWindow AnHTMLLink CompareStoredData StoredVP
                
                This will produce a CompareData VP with all the parameters appended
                like this: "VP=StoredVP;ExpectedResult=FAIL;Wait=3,30".
                NOTE:When stored parameters are found in the app map then the default Wait= 
                parameter used in the standard compare is no longer provided.  If you still 
                need a Wait= parameter, then it must be included in the stored parameters.
                
                The StoredVP baseline MUST already exist as an asset of the
                currently running script.
                  

Supporting Engines:

• Mercury Interactive WinRunner

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

vPAsset - Optional:NO Name of the pre-existing VP asset stored in the currently running script.

compareStoredProperties

public static ComponentFunction compareStoredProperties(java.lang.String winname,
                                                        java.lang.String compname,
                                                        java.lang.String vPAsset)

 
                Performs a HTMLLinkVP CompareProperties on an HTMLLink object.
               
                Performs a HTMLLinkVP CompareProperties on an HTMLLink object.
                
                THE BENCHMARK VP MUST ALREADY EXIST AND BE AN ASSET OF THE CURRENTLY
                RUNNING SCRIPT.
                
                Modified VP parameter information can be added to the standard
                VP=VPName by including the VPName reference in the application map
                in a section defined for the HTMLLink.  If this is done, the value 
                retrieved from the application map will be appended to VP=VPName.
                The required semicolon for this append will be provided by this routine.
                
                Example 1: Perform a standard HTMLLink CompareProperties.  To perform
                a basic CompareProperties the name "StoredVP" will not exist in the app map:
                
                The Step File call:
                    
                BrowserWindow AnHTMLLink CompareStoredProperties StoredVP
                   
                This will produce a CompareProperties VP with "VP=StoredVP;Wait=2,10".
                
                The StoredVP baseline MUST already exist as an asset of the
                currently running script.
                  
                Example 2: Perform a HTMLLink CompareProperties providing addition 
                parameter information (such as ExpectedResult=FAIL).  To do this the
                HTMLLink object must have its own section in the app map and an item
                with the same name as the StoredVP.  The value of that item will be
                appended to the standard VP argument with a semicolon.
                
                Part of App Map:
                
                [BrowserWindow]
                BrowserWindow=WindowTag=WEBBrowser
                AnHTMLLink=;\;Type=HTMLLink;HTMLID=LinkID
                ...
                [AnHTMLLink]
                StoredVP=ExpectedResult=FAIL;Wait=3,30
                
                The Step File call:
                 
                BrowserWindow AnHTMLLink CompareStoredProperties StoredVP
                
                This will produce a CompareProperties VP with all the parameters appended
                like this: "VP=StoredVP;ExpectedResult=FAIL;Wait=3,30".
                NOTE:When stored parameters are found in the app map then the default Wait= 
                parameter used in the standard compare is no longer provided.  If you still 
                need a Wait= parameter, then it must be included in the stored parameters.
                
                The StoredVP baseline MUST already exist as an asset of the
                currently running script.
                  

Supporting Engines:

• Mercury Interactive WinRunner

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

vPAsset - Optional:NO Name of the pre-existing VP asset stored in the currently running script.