BuiltinKeywords (Katalon Studio API Specification)

com.kms.katalon.core.keyword.BuiltinKeywords

@CompileStatic
class BuiltinKeywords
extends Object

Constructor Summary

Constructors
Constructor and description
`BuiltinKeywords ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static Object`	`callTestCase(TestCase calledTestCase, Map binding, FailureHandling flowControl)` Call and execute another test case
	`static Object`	`callTestCase(TestCase calledTestCase, Map binding)` Call and execute another test case
	`static void`	`comment(String message)`
	`static String`	`concatenate(String[] strings, FailureHandling flowControl)` Concatenate string array into a single string
	`static String`	`concatenate(String[] strings)` Concatenate string array into a single string
	`static void`	`delay(Number second, FailureHandling flowControl)` Delay execution for a specific time (in seconds)
	`static void`	`delay(Number second)` Delay execution for a specific time (in seconds)
	`static boolean`	`verifyCheckpoint(Checkpoint checkpoint, boolean logChangedValues, FailureHandling flowControl)` Verify Checkpoint
	`static boolean`	`verifyCheckpoint(Checkpoint checkpoint, boolean logChangedValues)` Verify Checkpoint
	`static boolean`	`verifyEqual(Object actualObject, Object expectedObject, FailureHandling flowControl)` Verify if two objects are equal.
	`static boolean`	`verifyEqual(Object actualObject, Object expectedObject)` Verify if two objects are equal.
	`static boolean`	`verifyGreaterThan(Object actualNumber, Object expectedNumber, FailureHandling flowControl)` Verify if the actual number is greater than the expected number
	`static boolean`	`verifyGreaterThan(Object actualNumber, Object expectedNumber)` Verify if the actual number is greater than the expected number
	`static boolean`	`verifyGreaterThanOrEqual(Object actualNumber, Object expectedNumber, FailureHandling flowControl)` Verify if the actual number is greater than or equal with the expected number
	`static boolean`	`verifyGreaterThanOrEqual(Object actualNumber, Object expectedNumber)` Verify if the actual number is greater than or equal with the expected number
	`static boolean`	`verifyLessThan(Object actualNumber, Object expectedNumber, FailureHandling flowControl)` Verify if the actual number is less than the expected number
	`static boolean`	`verifyLessThan(Object actualNumber, Object expectedNumber)` Verify if the actual number is less than the expected number
	`static boolean`	`verifyLessThanOrEqual(Object actualNumber, Object expectedNumber, FailureHandling flowControl)` Verify if the actual number is less than or equal with the expected number
	`static boolean`	`verifyLessThanOrEqual(Object actualNumber, Object expectedNumber)` Verify if the actual number is less than or equal with the expected number
	`static boolean`	`verifyMatch(String actualText, String expectedText, boolean isRegex, FailureHandling flowControl)` Verify if two strings match each other, the second string can be a regular expression.
	`static boolean`	`verifyMatch(String actualText, String expectedText, boolean isRegex)` Verify if two strings match each other, the second string can be a regular expression.
	`static boolean`	`verifyNotEqual(Object actualObject, Object expectedObject, FailureHandling flowControl)` Verify if two objects are not equal.
	`static boolean`	`verifyNotEqual(Object actualObject, Object expectedObject)` Verify if two objects are not equal.
	`static boolean`	`verifyNotMatch(String actualText, String expectedText, boolean isRegex, FailureHandling flowControl)` Verify if two strings do not match each other, the second string can be a regular expression.
	`static boolean`	`verifyNotMatch(String actualText, String expectedText, boolean isRegex)` Verify if two strings do not match each other, the second string can be a regular expression.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Constructor Detail
  - BuiltinKeywords()
- Method Detail
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static Object callTestCase(TestCase calledTestCase, Map binding, FailureHandling flowControl)
    
    Call and execute another test case
    throws:
    Exception
    
    Parameters:
    calledTestCase - represents a test case
    binding - contains variables bindings for the called test case. If the binding parameter is null, default values of all variables are used.
    flowControl
    Returns:
    returned value of called test case
  @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static Object callTestCase(TestCase calledTestCase, Map binding) Call and execute another test case throws: Exception Parameters: calledTestCase - represents a test case binding - contains variables bindings for the called test case. If the binding parameter is null, default values of all variables are used. Returns: returned value of called test case @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static void comment(String message) @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_TEXT) static String concatenate(String[] strings, FailureHandling flowControl) Concatenate string array into a single string throws: StepFailedException Parameters: strings - a string array flowControl Returns: the result string @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_TEXT) static String concatenate(String[] strings) Concatenate string array into a single string throws: StepFailedException Parameters: strings - a string array Returns: the result string @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static void delay(Number second, FailureHandling flowControl) Delay execution for a specific time (in seconds) throws: StepFailedException Parameters: second - number of seconds to delay. Eg: 0.5, 10, 30. flowControl @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static void delay(Number second) Delay execution for a specific time (in seconds) throws: StepFailedException Parameters: second - number of seconds to delay. Eg: 0.5, 10, 30. @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static boolean verifyCheckpoint(Checkpoint checkpoint, boolean logChangedValues, FailureHandling flowControl) Verify Checkpoint throws: StepFailedException if data does not match Parameters: checkpoint - Checkpoint logChangedValues - true will log all the changed value between checkpoint data and the source. false will not log any changed value. flowControl - failure handling Returns: true if checked data of checkpoint matches their source data. Otherwise, false. @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static boolean verifyCheckpoint(Checkpoint checkpoint, boolean logChangedValues) Verify Checkpoint throws: StepFailedException if data does not match Parameters: checkpoint - Checkpoint logChangedValues - true will log all the changed value between checkpoint data and the source. false will not log any changed value. Returns: true if checked data of checkpoint matches their source data. Otherwise, false. @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyEqual(Object actualObject, Object expectedObject, FailureHandling flowControl) Verify if two objects are equal. throws: StepFailedException throws: StepErrorException Parameters: actualObject expectedObject flowControl Returns: true if actual object is equals with expected object; otherwise, false @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyEqual(Object actualObject, Object expectedObject) Verify if two objects are equal. throws: StepFailedException throws: StepErrorException Parameters: actualObject expectedObject Returns: true if actual object is equals with expected object; otherwise, false @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyGreaterThan(Object actualNumber, Object expectedNumber, FailureHandling flowControl) Verify if the actual number is greater than the expected number throws: StepFailedException Parameters: actualNumber expectedNumber flowControl Returns: true the actual number is greater than the expected number; otherwise false @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyGreaterThan(Object actualNumber, Object expectedNumber) Verify if the actual number is greater than the expected number throws: StepFailedException Parameters: actualNumber expectedNumber Returns: true the actual number is greater than the expected number; otherwise false @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyGreaterThanOrEqual(Object actualNumber, Object expectedNumber, FailureHandling flowControl) Verify if the actual number is greater than or equal with the expected number throws: StepFailedException Parameters: actualNumber expectedNumber flowControl Returns: true the actual number is greater than or equal with the expected number ; otherwise false @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyGreaterThanOrEqual(Object actualNumber, Object expectedNumber) Verify if the actual number is greater than or equal with the expected number throws: StepFailedException Parameters: actualNumber expectedNumber Returns: true the actual number is greater than or equal with the expected number ; otherwise false @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyLessThan(Object actualNumber, Object expectedNumber, FailureHandling flowControl) Verify if the actual number is less than the expected number throws: StepFailedException Parameters: actualNumber expectedNumber flowControl Returns: true the actual number is less than the expected number; otherwise false @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyLessThan(Object actualNumber, Object expectedNumber) Verify if the actual number is less than the expected number throws: StepFailedException Parameters: actualNumber expectedNumber Returns: true the actual number is less than the expected number; otherwise false @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyLessThanOrEqual(Object actualNumber, Object expectedNumber, FailureHandling flowControl) Verify if the actual number is less than or equal with the expected number throws: StepFailedException Parameters: actualNumber expectedNumber flowControl Returns: true the actual number is less than or equal with the expected number; otherwise false @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyLessThanOrEqual(Object actualNumber, Object expectedNumber) Verify if the actual number is less than or equal with the expected number throws: StepFailedException Parameters: actualNumber expectedNumber Returns: true the actual number is less than or equal with the expected number; otherwise false @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_TEXT) static boolean verifyMatch(String actualText, String expectedText, boolean isRegex, FailureHandling flowControl) Verify if two strings match each other, the second string can be a regular expression. throws: StepFailedException Parameters: actualText expectedText isRegex - whether string2 is regular expression or not, has two values true, false (default if left empty) flowControl Returns: whether two strings match, has two values true, false @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_TEXT) static boolean verifyMatch(String actualText, String expectedText, boolean isRegex) Verify if two strings match each other, the second string can be a regular expression. throws: StepFailedException Parameters: actualText expectedText isRegex - whether string2 is regular expression or not, has two values true, false (default if left empty) Returns: whether two strings match, has two values true, false @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyNotEqual(Object actualObject, Object expectedObject, FailureHandling flowControl) Verify if two objects are not equal. throws: StepFailedException throws: StepErrorException Parameters: actualNumber expectedNumber flowControl Returns: true if actual object is not equals with expected object; otherwise, false @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyNotEqual(Object actualObject, Object expectedObject) Verify if two objects are not equal. throws: StepFailedException throws: StepErrorException Parameters: actualNumber expectedNumber Returns: true if actual object is not equals with expected object; otherwise, false @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_TEXT) static boolean verifyNotMatch(String actualText, String expectedText, boolean isRegex, FailureHandling flowControl) Verify if two strings do not match each other, the second string can be a regular expression. throws: StepFailedException Parameters: actualText expectedText isRegex - whether string2 is regular expression or not, has two values true, false (default if left empty) flowControl Returns: whether two strings do not match, has two values true, false @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_TEXT) static boolean verifyNotMatch(String actualText, String expectedText, boolean isRegex) Verify if two strings do not match each other, the second string can be a regular expression. throws: StepFailedException Parameters: actualText expectedText isRegex - whether string2 is regular expression or not, has two values true, false (default if left empty) Returns: whether two strings do not match, has two values true, false






    

    

    
        Overview
        Package
        Class
        Deprecated
        Index
        Help
    



    
        
            Frames
            No Frames
        
    
    
        
            Summary: 
            Nested   Field      Constructor
   Method   
        
        
             | Detail: 
            Field      Constructor
   Method

[Groovy] Class BuiltinKeywords

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

BuiltinKeywords()

Method Detail

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static Object callTestCase(TestCase calledTestCase, Map binding, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static Object callTestCase(TestCase calledTestCase, Map binding)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static void comment(String message)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_TEXT) static String concatenate(String[] strings, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_TEXT) static String concatenate(String[] strings)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static void delay(Number second, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static void delay(Number second)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static boolean verifyCheckpoint(Checkpoint checkpoint, boolean logChangedValues, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static boolean verifyCheckpoint(Checkpoint checkpoint, boolean logChangedValues)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyEqual(Object actualObject, Object expectedObject, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyEqual(Object actualObject, Object expectedObject)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyGreaterThan(Object actualNumber, Object expectedNumber, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyGreaterThan(Object actualNumber, Object expectedNumber)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyGreaterThanOrEqual(Object actualNumber, Object expectedNumber, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyGreaterThanOrEqual(Object actualNumber, Object expectedNumber)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyLessThan(Object actualNumber, Object expectedNumber, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyLessThan(Object actualNumber, Object expectedNumber)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyLessThanOrEqual(Object actualNumber, Object expectedNumber, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyLessThanOrEqual(Object actualNumber, Object expectedNumber)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_TEXT) static boolean verifyMatch(String actualText, String expectedText, boolean isRegex, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_TEXT) static boolean verifyMatch(String actualText, String expectedText, boolean isRegex)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyNotEqual(Object actualObject, Object expectedObject, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_NUMBER) static boolean verifyNotEqual(Object actualObject, Object expectedObject)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_TEXT) static boolean verifyNotMatch(String actualText, String expectedText, boolean isRegex, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_TEXT) static boolean verifyNotMatch(String actualText, String expectedText, boolean isRegex)