Open topic with navigation

com.hp.lft.sdk.sap.ui5

## Class RatingIndicatorDescription

- java.lang.Object
- - com.hp.lft.sdk.internal.PropertiesDescriptionBase
  - - com.hp.lft.sdk.PropertiesDescription
    - - com.hp.lft.sdk.DescriptionBase
      - - com.hp.lft.sdk.web.WebBaseDescription
        - - com.hp.lft.sdk.web.WebElementDescription
          - - com.hp.lft.sdk.sap.ui5.RatingIndicatorDescription

- All Implemented Interfaces:
    CloneableObject, Description, com.hp.lft.sdk.internal.DescriptionWithVri, java.lang.Cloneable

      public class RatingIndicatorDescription
      extends WebElementDescription

  The description of an SAPUI5 RatingIndicator test object.

- - ### Nested Class Summary

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

  - ### Field Summary

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

      `properties`

  - ### Constructor Summary

    Modifier | Constructor and Description
    --- | ---
    `` | `RatingIndicatorDescription()` Initializes a new instance of the RatingIndicatorDescription class.
    `protected` | `RatingIndicatorDescription(RatingIndicatorDescription.Init<?> init)` Initializes a new instance of the RatingIndicatorDescription class using the Builder pattern.

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.lang.Integer` | `getMaxRating()` Returns the highest rating level that can be set.
    `Orientation` | `getOrientation()` Returns the orientation of rating indicator items.
    `java.lang.Double` | `getRating()` Returns the rating level set for the object.
    `java.lang.Boolean` | `isEnabled()` Returns whether the object is enabled.
    `void` | `setEnabled(java.lang.Boolean enabled)` Sets whether the object is enabled.
    `void` | `setMaxRating(java.lang.Integer max)` Sets the highest rating level that can be set.
    `void` | `setOrientation(Orientation orientation)` Sets the orientation of the rating indicator.
    `void` | `setRating(java.lang.Double rating)` Sets the rating level of the ratingindicator.

    - ### Methods inherited from class com.hp.lft.sdk.web.WebElementDescription

      `getAccessibilityName, getCSSSelector, getRole, getXPath, setAccessibilityName, setAccessibilityName, setCSSSelector, setCSSSelector, setRole, setRole, setXPath, setXPath`

    - ### Methods inherited from class com.hp.lft.sdk.web.WebBaseDescription

      `cloneTo, getAbsoluteLocation, getAttributes, getClassName, getId, getInnerHTML, getInnerText, getLocation, getName, getOuterHTML, getOuterText, getSize, getStyles, getTagName, getTitle, isVisible, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setAttributes, setClassName, setClassName, setId, setId, setInnerHTML, setInnerHTML, setInnerText, setInnerText, setLocation, setLocation, setLocation, setName, setName, setOuterHTML, setOuterHTML, setOuterText, setOuterText, setSize, setSize, setSize, setStyles, setTagName, setTagName, setTitle, setTitle, setVisible`

    - ### Methods inherited from class com.hp.lft.sdk.DescriptionBase

      `getIndex, getIndexType, getVRI, setIndex, setIndexType, setVRI, setVRI`

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

    - #### RatingIndicatorDescription

          public RatingIndicatorDescription()

      Initializes a new instance of the RatingIndicatorDescription class.

    - #### RatingIndicatorDescription

          protected RatingIndicatorDescription(RatingIndicatorDescription.Init<?> init)

      Initializes a new instance of the RatingIndicatorDescription class using the Builder pattern.
      Parameters:
        `init` - the Builder pattern.

  - ### Method Detail

    - #### setEnabled

          public void setEnabled(java.lang.Boolean enabled)

      Sets whether the object is enabled.
      Parameters:
        `enabled` - true to enable the object.

    - #### isEnabled

          public java.lang.Boolean isEnabled()

      Returns whether the object is enabled.
      Returns:
        True if enabled.

    - #### setRating

          public void setRating(java.lang.Double rating)

      Sets the rating level of the ratingindicator.
      Parameters:
        `rating` - the rating level to set.

    - #### getRating

          public java.lang.Double getRating()

      Returns the rating level set for the object.
      Returns:
        The rating level set for the object.

    - #### setMaxRating

          public void setMaxRating(java.lang.Integer max)

      Sets the highest rating level that can be set.
      Parameters:
        `max` - the highest rating level that can be set.

    - #### getMaxRating

          public java.lang.Integer getMaxRating()

      Returns the highest rating level that can be set.
      Returns:
        The highest rating level that can be set.

    - #### setOrientation

          public void setOrientation(Orientation orientation)

      Sets the orientation of the rating indicator.
      Parameters:
        `orientation` - the display mode of the rating indicator items. Possible values: `Orientation`

    - #### getOrientation

          public Orientation getOrientation()

      Returns the orientation of rating indicator items.
      Returns:
        The orientation of rating indicator items. Possible values: `Orientation`