Share this page

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, java.lang.Cloneable
  Direct Known Subclasses:
    ElementDescription, FieldDescription, GuiSessionDescription, InsightDescription, PageDescription, ScreenDescription, TextScreenDescription, 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

    Modifier and Type | Class and 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

    Modifier | Constructor and 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 and Description
    --- | ---
    `protected void` | `cloneTo(java.lang.Object clonedObject)` Creates an exact copy of the test object with its description.
    `java.lang.Integer` | `getIndex()` Returns the 0-based index of this object, relative to all other objects with an otherwise identical description.
    `java.lang.String` | `getIndexType()` Returns the index type of the description.
    `java.util.List<VisualRelation>` | `getVRI()` Returns the VisualRelation definition.
    `void` | `setIndex(java.lang.Integer index)` Sets the index of this object.
    `protected void` | `setIndexType(java.lang.String indexType)` Sets the index type of the description.
    `void` | `setVRI(java.util.List<VisualRelation> visualRelations)` Sets a VisualRelation definition.
    `void` | `setVRI(VisualRelation... vriRelations)` 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 Detail

    - #### 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 Detail

    - #### setIndex

          public void setIndex(java.lang.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 java.lang.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(java.lang.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 java.lang.String getIndexType()

      Returns the index type of the description.
      Returns:
        the index type.

    - #### getVRI

          public java.util.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(java.util.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.

    - #### cloneTo

          protected void cloneTo(java.lang.Object clonedObject)
                          throws java.lang.CloneNotSupportedException

      Creates an exact copy of the test object with its description.
      Overrides:
        `cloneTo` in class `com.hp.lft.sdk.internal.PropertiesDescriptionBase`
      Throws:
        `java.lang.CloneNotSupportedException`

Tips to improve your search results... UFT Developer Java SDK Reference Version 15.0-15.0.2 UFT Developer SDK Reference All View Local Help Center View Online Help Center back Go back in browser history forward Go forward in browser history Remove search highlights next topic Go to next topic previous topic Go to previous topic Print the current topic Version: