Open topic with navigation

# Package com.hp.lft.sdk

Provides the SDK for core LeanFT functionality.

See: Description

- Interface | Description
  --- | ---
  AlmRunInfo | An object that includes test or business component information originating from ALM.
  Aut | An abstraction of an AUT process launched by the user.
  BusinessComponentRunInfo | An object representing the ALM Business Component information.
  CalendarBase | Base interface for Calendar test objects.
  Clickable | Indicates that this object can be clicked.
  CloneableObject | Indicates a test object that exposes a public Clone method.
  Description | Interface for a class to be used as a test object description.
  DesktopEnvironment | Represents an environment on which LeanFT performs test operations.
  DoubleClickable | Indicates that this object can be double-clicked.
  EnabledProvider | A TestObject that supports the isEnabled method.
  Environment | Base interface for AUT environments.
  KeyboardDevice | An interface that provides low-level keyboard operations.
  LocationInfoProvider | Indicates that a test object supports accessing properties of its location on the screen.
  MenuItemBase | Base interface for all MenuItem interfaces in SDK.
  MouseDevice | An interface that provides low-level mouse operations.
  NativeObject | Exposes invocation capabilities available for native objects that were returned by the `NativeObject` method.
  Scrollable | Represents test objects that support scrolling.
  SDKConfiguration | Defines the configuration information for the SDK.
  SupportDragAndDrop | A test object that supports drag and drop.
  SupportSendKeys | A test object that supports the `sendKeys` method.
  SupportsNativeObject | A test object that supports the getNativeObject property, which returns a proxy of the native object represented by this test object instance.
  TestObject | Base interface for all test objects.
  TestObjectDescriber | Base interface for all classes that support describing test objects.
  TopLevelObject | The interface marks test object types that can be decribed from the Desktop.
  UiObjectBase | Base interface for all UiObjects in all technologies.
  VisibleProvider | A TestObject that supports the isVisible method.
  WaitUntilEnabledProvider | A test object that supports the waitUntilEnabled method.
  WaitUntilTestObjectState.WaitUntilEvaluator<T extends TestObject> | This interface exposes the evaluate method, which evaluates if an object in the AUT is currently in a specific state.
  WaitUntilVisibleProvider | A test object that supports the waitUntilVisible method.

- Class | Description
  --- | ---
  AppModelBase | Base class of all generated Application Model classes.
  AppModelNodeBase<T extends TestObject,TDescription extends Description> | Base class for all container sub-classes generated under the Application Model class.
  ClickArgs | Class defining operations that can be specified in a Click operation.
  DateRange | A range of dates used for month calendar controls that support multi-selection.
  DescriptionBase | The base class for all Description classes that support the index and Visual Relation Identifier (VRI) test object properties.
  DescriptionBase.Builder | This class can be used to construct an instance of the DescriptionBase class using the builder pattern.
  DescriptionBase.Init<T extends DescriptionBase.Init<T>> | Helper class for DescriptionBase.Builder.
  Desktop | A top-level Window or Dialog test object.
  DragAndDropArgs | Class defining the behavior for drag and drop operations.
  EnvironmentDescription | An object describing the environment that the test requires, in capability name-value pairs.
  EnvironmentDescription.Builder | This class can be used to construct an instance of the EnvironmentDescription class using the builder pattern.
  EnvironmentDescription.Init<T extends EnvironmentDescription.Init<T>> | Helper class for EnvironmentDescription.Builder.
  EnvironmentFactory | A class for creating an `DesktopEnvironment` instance.
  FunctionKeys | Supplies constants representing the Function keyboard keys(F1 - F12), which can be used in the input parameter string of the `sendKeys` method.
  ImageMaskArea | A class representing image mask rectangle areas.
  Keyboard | A class that enables low-level keyboard operations.
  Keys | Supplies constants representing keyboard keys, which can be used in the input parameter string of the `sendKeys` method.
  Location | Provides a location (relative to an object in the application) for operations that support it.
  LocationProperty | Class for defining a test object's location property.
  ModifiableSDKConfiguration | Interface for defining the configuration information for the SDK.
  Mouse | A class that enables low-level mouse operations.
  PropertiesDescription | The base of all test object descriptions.
  RegExpProperty | The class used for regular expression properties.
  ScrollInfo | Class representing the properties of a scroll bar.
  ScrollProperty | The class used for scrollbar properties.
  SDK | The LeanFT base class.
  SDKConfigurationFactory | Factory for creating an SDK configuration.
  SizeProperty | The size properties of a test object.
  SrfLab | This class can be used to launch browsers or lock devices in the SRF lab.
  StringProperty | Represents a string property in a description of a test object.
  SvInfo | Represents the Service Virutalization server data.
  TopLevelObjectNodeBase<T extends TopLevelObject,TDescription extends Description> | This class is used by 'Application Model Code Generator' as the base class for all container classes.
  VideoData | An object that holds video binary data.
  VisualRelation | Class representing Visual Relations Identifier (VRI) data. Each VisualRelation class contains a reference to a test object, and up to three possible relations: horizontal relation, vertical relation, and proximity relation. The VisualRelation class can be initialized using the following builder pattern:
  WaitUntilTestObjectState | This class provides the waitUntil static method, which can be used to wait until an object reaches a specific state.

- Enum | Description
  --- | ---
  CheckedState | Represents the check box state.
  HorizontalVisualRelation | The horizontal location of the related test object relative to the object to identify.
  ImageFormat | Formats which can be used in ImageData construction.
  Keyboard.Keys | Keys which can be used in sending keyboards events.
  KeyModifier | Represents keyboard keys that can be pressed and held down during the execution of a method, such as the SendKeys method.
  MouseButton | The mouse button to use for mouse operations.
  Orientation | The visual orientation of an object.
  Position | Indicates the position for an offset relative to this object in the application.
  ProximityVisualRelation | The distance or hierarchical location of the related test object relative to the object to identify.
  RunningLeanFtTestType | Represents the possible running ALM test types
  ScrollOrientation | Represents the scroll bar orientation.
  ScrollType | The type of scrolling operation.
  SDKMode | Indicates which mode the LeanFT runtime engine uses for test runs.
  SwipeDirection | Options for swipe direction.
  VerticalVisualRelation | The vertical location of the related test object relative to the object to identify.
  VideoFormat | Formats which can be used in VideoData construction.
  WindowExtendedStyles | Extended window styles as defined in the Windows API.
  WindowState | The window state.
  WindowStyles | Window styles as defined in the Windows API.

- Exception | Description
  --- | ---
  DescriptionException | An Exception that is raised when errors are encountered in the description of test objects.
  EmptySessionIdException | The exception that is thrown when an empty session ID is received from the LeanFT server.
  GeneralGridException | The exception that is thrown when a general grid exception is thrown .
  GeneralLeanFtException | Represents general errors that occur during LeanFT application execution.
  GeneralReplayException | Represents general errors that occur during replay stage of the LeanFT application.
  GeneralServerErrorException | Represent general errors that occur on the LeanFT server side.
  InvalidAgentException | The exception that is thrown when a message with an invalid agent field value is received by the LeanFT server.
  InvalidFormatException | The exception that is thrown when an invalid formated message is received by the LeanFT server.
  InvalidMessageFieldException | The exception that is thrown when a message with an invalid field value is received by the LeanFT server.
  InvalidVersionException | The exception that is thrown when a message with invalid version is received by the LeanFT server.
  LabNotConnectedException | The exception that is thrown when the LeanFT runtime engine is not connected to the expected Lab.
  MessageTypeNotSupportedException | The exception that is thrown when a not supported message type received by the LeanFT server.
  MobileCenterNotConnectedException | The exception that is thrown when the LeanFT runtime engine is not connected to mobile center.
  NodeUnavailableException | The exception that is thrown when a grid has found a node with a matching capabilities but it is currently locked.
  NoMatchingNodeFoundExceptionGeneral | The exception that is thrown when a grid has not found any registered node with the given capabilities
  NoValidLicenseException | The exception that is thrown when no valid LeanFT license is found.
  ObjectCookieNotFoundException | The exception that is thrown when a test object cookie is not found in the LeanFT server.
  ReplayArgumentOutOfRangeException | The exception that is thrown when the value of an argument to a method is outside the allowable range of values, as defined by the invoked replay method.
  ReplayBrowserNotInstalledException | The exception that is thrown when the browser type requested to launch is not installed.
  ReplayItemNotFoundException | The exception that is thrown when an item of the test object is not found in the AUT.
  ReplayItemNotUniqueException | The exception that is thrown when an item of the test object can't be uniquely identified in the AUT.
  ReplayObjectDisabledException | The exception that is thrown when a test object with the given description is disabled in the AUT.
  ReplayObjectNotFoundException | The exception that is thrown when a test object with the given description is not found in the AUT.
  ReplayObjectNotUniqueException | The exception that is thrown when a test object's description is not sufficient to uniquely identify the test object in the AUT.
  ReplayObjectNotVisibleException | The exception that is thrown when a test object with the given description is not visible in the AUT.
  ReplayParentMissingException | The exception that is thrown when a parent of the test object with the given description is not found in the AUT.
  ReplayTimeoutException | The exception that is thrown when a time out occurred during replay.
  ServerAlreadyInRecordModeException | The exception that is thrown, when a start record request is received by the LeanFT server, which is already in a record mode.
  ServerIsShuttingDownException | The exception that is thrown when an attempting to access the LeanFT server while it is shutting down.
  SessionNotFoundException | The exception that is thrown when an unknown session ID is received by the LeanFT server.
  VriDescriptionException | Exception raised when errors are encountered in the VRI description of test objects.