Package com.hp.lft.sdk.ai

Class AiObjectDescription

java.lang.Object
com.hp.lft.sdk.internal.PropertiesDescriptionBase
com.hp.lft.sdk.PropertiesDescription
com.hp.lft.sdk.ai.AiObjectDescription
All Implemented Interfaces:
CloneableObject, Description, com.hp.lft.sdk.internal.MapHolder, Cloneable
public class AiObjectDescription extends PropertiesDescription implements com.hp.lft.sdk.internal.MapHolder
The description of a AiObject test object.

  • Constructor Details

    • AiObjectDescription

      public AiObjectDescription()
      Constructs a new AiObjectDescription.

    • AiObjectDescription

      public AiObjectDescription(String aiClass)
      Constructs a new AiObjectDescription.
      Parameters:
      aiClass - the AI Class type of the AI object (you can use the AiTypes helper class).

    • AiObjectDescription

      public AiObjectDescription(String aiClass, String text)
      Constructs a new AiObjectDescription.
      Parameters:
      aiClass - the AI Class type of the AI object (you can use the AiTypes helper class).
      text - the text used to identify the AI Object.

    • AiObjectDescription

      public AiObjectDescription(String aiClass, RegExpProperty regExp)
      Constructs a new AiObjectDescription.
      Parameters:
      aiClass - the AI Class type of the AI object (you can use the AiTypes helper class).
      regExp - the RegExpProperty used to identify the AI object.

    • AiObjectDescription

      public AiObjectDescription(String aiClass, TextWithMatchOptions textWithMatchOptions)
      Constructs a new AiObjectDescription.
      Parameters:
      aiClass - the AI Class type of the AI object (you can use the AiTypes helper class).
      textWithMatchOptions - the text and match method used to identify the AI Object.

    • AiObjectDescription

      protected AiObjectDescription(AiObjectDescription.Init<?> init)

  • Method Details

    • setAiClass

      public void setAiClass(String aiClass)
      Sets the AI Class type of the AI object.
      Parameters:
      aiClass - the AI Class type of the AI object (you can use the AiTypes helper class).

    • getAiClass

      public String getAiClass()
      Returns the AI Class type of the AI object.
      Returns:
      the AI Class type of the AI object.

    • setText

      public void setText(String text)
      Sets the text used to identify the AI Object.
      Parameters:
      text - the text used to identify the AI Object.

    • setRegExp

      public void setRegExp(String pattern)
      Sets the regular expression used to identify the AI Object.
      Parameters:
      pattern - the regular expression used to identify the AI Object.

    • getRegExp

      public RegExpProperty getRegExp()
      Returns the regular expression used to identify the AI Object.
      Returns:
      the regular expression used to identify the AI Object.

    • getText

      public StringProperty getText()
      Returns the text used to identify the AI Object.
      Returns:
      the text used to identify the AI Object.

    • setTextWithMatchOptions

      public void setTextWithMatchOptions(TextWithMatchOptions textWithMatchOptions)
      Sets the text and match method used to identify the AI Object.
      Parameters:
      textWithMatchOptions - the text and match method used to identify the AI Object .

    • getTextWithMatchOptions

      public TextWithMatchOptions getTextWithMatchOptions()
      Returns the text and match method used to identify the AI Object.
      Returns:
      the text and match method used to identify the AI Object.

    • setLocator

      public void setLocator(Locator locator)
      Sets the locator to distinguish between objects matching the same description.
      Parameters:
      locator - the locator to use to uniquely identify the object.

    • getLocator

      public Locator getLocator()
      Returns the Locator that distinguishes between objects matching the same description.
      Returns:
      the Locator that distinguishes between objects matching the same description.

    • getMap

      public Map<String,Object> getMap()
      For internal use only.
      Specified by:
      getMap in interface com.hp.lft.sdk.internal.MapHolder
      Returns:
      for internal use only.