Package com.hp.lft.sdk

Class DescriptionBase

java.lang.Object
com.hp.lft.sdk.internal.PropertiesDescriptionBase
com.hp.lft.sdk.PropertiesDescription
com.hp.lft.sdk.DescriptionBase
All Implemented Interfaces:
CloneableObject, Description, com.hp.lft.sdk.internal.DescriptionWithVri, Cloneable
Direct Known Subclasses:
ElementDescription, FieldDescription, GuiSessionDescription, InsightDescription, PageDescription, ScreenDescription, TextScreenDescription, UiObjectBaseDescription, UiObjectBaseDescription, UiObjectBaseDescription, UiObjectBaseDescription, UiObjectBaseDescription, UiObjectDescriptionBase, UiObjectDescriptionBase, WebBaseDescription, WindowDescription
public class DescriptionBase extends PropertiesDescription implements com.hp.lft.sdk.internal.DescriptionWithVri
The base class for all Description classes that support the index and Visual Relation Identifier (VRI) test object properties.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    DescriptionBase.Builder
    This class can be used to construct an instance of the DescriptionBase class using the builder pattern.
    protected static class 
    DescriptionBase.Init<T extends DescriptionBase.Init<T>>
    Helper class for DescriptionBase.Builder.

  • Field Summary

    Fields inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

    properties

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    DescriptionBase()
    Initializes a new instance of the DescriptionBase class with an empty description.
    protected
    DescriptionBase(DescriptionBase.Init<?> init)
    Initializes a new instance of the DescriptionBase class using the Builder pattern.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    cloneTo(Object clonedObject)
    Creates an exact copy of the test object with its description.
    Integer
    getIndex()
    Returns the 0-based index of this object, relative to all other objects with an otherwise identical description.
    String
    getIndexType()
    Returns the index type of the description.
    Map<String,Object>
    getObjectProperties()
    Returns the concrete test object properties, including custom properties created by the developer of the control.
    List<VisualRelation>
    getVRI()
    Returns the VisualRelation definition.
    void
    setIndex(Integer index)
    Sets the index of this object.
    protected void
    setIndexType(String indexType)
    Sets the index type of the description.
    void
    setObjectProperties(Map<String,Object> objectProperties)
    Sets the test object properties, including custom properties of a custom control.
    void
    setVRI(VisualRelation... vriRelations)
    Sets a VisualRelation definition.
    void
    setVRI(List<VisualRelation> visualRelations)
    Sets a VisualRelation definition.

    Methods inherited from class com.hp.lft.sdk.PropertiesDescription

    clone

    Methods inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

    getValueAs, getValueAsStringProperty, insertValue

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.hp.lft.sdk.CloneableObject

    clone

  • Constructor Details

    • DescriptionBase

      protected DescriptionBase(DescriptionBase.Init<?> init)
      Initializes a new instance of the DescriptionBase class using the Builder pattern.
      Parameters:
      init - the Builder pattern.

    • DescriptionBase

      public DescriptionBase()
      Initializes a new instance of the DescriptionBase class with an empty description.

  • Method Details

    • setIndex

      public void setIndex(Integer index)
      Sets the index of this object.
      The index helps to distinguish the object, based on its order of appearance in the application screen relative to all other objects with an otherwise identical description.
      Parameters:
      index - the index of the object.

    • getIndex

      public Integer getIndex()
      Returns the 0-based index of this object, relative to all other objects with an otherwise identical description.
      Returns:
      the index of the object.

    • setIndexType

      protected void setIndexType(String indexType)
      Sets the index type of the description.
      The type of the index for the description
      Parameters:
      indexType - the index type of the description.

    • getIndexType

      public String getIndexType()
      Returns the index type of the description.
      Returns:
      the index type.

    • getVRI

      public List<VisualRelation> getVRI()
      Returns the VisualRelation definition.
      The VRI definition helps to distinguish this object from other objects with otherwise identical descriptions, based on this object's visual relationship to another object in the application.
      Specified by:
      getVRI in interface com.hp.lft.sdk.internal.DescriptionWithVri
      Returns:
      a VisualRelation object containing the VRI definition for this object.

    • setVRI

      public void setVRI(List<VisualRelation> visualRelations)
      Sets a VisualRelation definition.
      The VRI definition helps to distinguish this object from other objects with otherwise identical descriptions, based on this object's visual relationship to another object in the application.
      Specified by:
      setVRI in interface com.hp.lft.sdk.internal.DescriptionWithVri
      Parameters:
      visualRelations - the VisualRelation object containing the VRI definition for this object.

    • setVRI

      public void setVRI(VisualRelation... vriRelations)
      Sets a VisualRelation definition.
      The VRI definition helps to distinguish this object from other objects with otherwise identical descriptions, based on this object's visual relationship to another object in the application.
      Specified by:
      setVRI in interface com.hp.lft.sdk.internal.DescriptionWithVri
      Parameters:
      vriRelations - the VisualRelation object containing the VRI definition for this object.

    • setObjectProperties

      public void setObjectProperties(Map<String,Object> objectProperties)
      Sets the test object properties, including custom properties of a custom control.
      Parameters:
      objectProperties - the test object properties

    • getObjectProperties

      public Map<String,Object> getObjectProperties()
      Returns the concrete test object properties, including custom properties created by the developer of the control.
      Returns:
      the concrete test object properties, including custom properties created by the developer of the control.

    • cloneTo

      protected void cloneTo(Object clonedObject) throws CloneNotSupportedException
      Creates an exact copy of the test object with its description.
      Overrides:
      cloneTo in class com.hp.lft.sdk.internal.PropertiesDescriptionBase
      Throws:
      CloneNotSupportedException