Open topic with navigation

com.hp.lft.sdk.sap.gui

## Class GuiSessionDescription

- java.lang.Object
- - com.hp.lft.sdk.internal.PropertiesDescriptionBase
  - - com.hp.lft.sdk.PropertiesDescription
    - - com.hp.lft.sdk.DescriptionBase
      - - com.hp.lft.sdk.sap.gui.GuiSessionDescription

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

      public class GuiSessionDescription
      extends DescriptionBase

  The description of a SAP GUI Session object.

- - ### Nested Class Summary

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

  - ### Field Summary

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

      `properties`

  - ### Constructor Summary

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

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `StringProperty` | `getApplicationServer()` Returns the session's application server name.
    `StringProperty` | `getClient()` Returns the client selected on the login screen.
    `java.lang.Long` | `getCodePage()` Returns the code page in use in this session.
    `StringProperty` | `getId()` Returns the ID.
    `StringProperty` | `getLanguage()` Returns the language the user is working in.
    `StringProperty` | `getName()` Returns the session's name.
    `StringProperty` | `getSystemName()` Returns the name of the SAP system.
    `java.lang.Long` | `getSystemNumber()` Returns the system number for this session.
    `StringProperty` | `getUser()` Returns the user name for the session.
    `void` | `setApplicationServer(java.lang.String applicationServer)` Sets the session's application server name.
    `void` | `setApplicationServer(StringProperty applicationServer)` Sets the session's application server name.
    `void` | `setClient(java.lang.String client)` Sets the client selected on the login screen.
    `void` | `setClient(StringProperty client)` Sets the client selected on the login screen.
    `void` | `setCodePage(java.lang.Long codePage)` Sets the code page in use in this session.
    `void` | `setId(java.lang.String id)` Sets the session's ID in text format.
    `void` | `setId(StringProperty id)` Sets the session's ID in text format.
    `void` | `setLanguage(java.lang.String language)` Sets the language the user is working in.
    `void` | `setLanguage(StringProperty language)` Sets the language the user is working in.
    `void` | `setName(java.lang.String name)` Sets the session's name.
    `void` | `setName(StringProperty name)` Sets the session's name.
    `void` | `setSystemName(java.lang.String systemName)` Sets the name of the SAP system.
    `void` | `setSystemName(StringProperty systemName)` Sets the name of the SAP system.
    `void` | `setSystemNumber(java.lang.Long systemNumber)` Sets the system number for this session.
    `void` | `setUser(java.lang.String user)` Sets the user name for the session.
    `void` | `setUser(StringProperty user)` Sets the user name for the session.

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

      `cloneTo, 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

    - #### GuiSessionDescription

          public GuiSessionDescription()

      Initializes a new instance of the GuiSessionDescription class.

    - #### GuiSessionDescription

          protected GuiSessionDescription(GuiSessionDescription.Init<?> init)

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

  - ### Method Detail

    - #### setId

          public void setId(StringProperty id)

      Sets the session's ID in text format.
      Parameters:
        `id` - a `StringProperty` or `RegExpProperty`.

    - #### setId

          public void setId(java.lang.String id)

      Sets the session's ID in text format.
      Parameters:
        `id` - the ID.

    - #### getId

          public StringProperty getId()

      Returns the ID.
      Returns:
        the ID.

    - #### setName

          public void setName(StringProperty name)

      Sets the session's name.
      Parameters:
        `name` - a `StringProperty` or `RegExpProperty`.

    - #### setName

          public void setName(java.lang.String name)

      Sets the session's name.
      Parameters:
        `name` - the name.

    - #### getName

          public StringProperty getName()

      Returns the session's name.
      Returns:
        the name.

    - #### setApplicationServer

          public void setApplicationServer(StringProperty applicationServer)

      Sets the session's application server name.
      Parameters:
        `applicationServer` - a `StringProperty` or `RegExpProperty`.

    - #### setApplicationServer

          public void setApplicationServer(java.lang.String applicationServer)

      Sets the session's application server name.
      Parameters:
        `applicationServer` - the application server name.

    - #### getApplicationServer

          public StringProperty getApplicationServer()

      Returns the session's application server name.
      Returns:
        the application server name.

    - #### setClient

          public void setClient(StringProperty client)

      Sets the client selected on the login screen.
      Parameters:
        `client` - a `StringProperty` or `RegExpProperty`.

    - #### setClient

          public void setClient(java.lang.String client)

      Sets the client selected on the login screen.
      Parameters:
        `client` - the client.

    - #### getClient

          public StringProperty getClient()

      Returns the client selected on the login screen.
      Returns:
        the client.

    - #### setLanguage

          public void setLanguage(StringProperty language)

      Sets the language the user is working in.
      Parameters:
        `language` - a `StringProperty` or `RegExpProperty`.

    - #### setLanguage

          public void setLanguage(java.lang.String language)

      Sets the language the user is working in.
      Parameters:
        `language` - the language.

    - #### getLanguage

          public StringProperty getLanguage()

      Returns the language the user is working in.
      Returns:
        the language.

    - #### setSystemName

          public void setSystemName(StringProperty systemName)

      Sets the name of the SAP system.
      Parameters:
        `systemName` - a `StringProperty` or `RegExpProperty`.

    - #### setSystemName

          public void setSystemName(java.lang.String systemName)

      Sets the name of the SAP system.
      Parameters:
        `systemName` - the name.

    - #### getSystemName

          public StringProperty getSystemName()

      Returns the name of the SAP system.
      Returns:
        the name.

    - #### setUser

          public void setUser(StringProperty user)

      Sets the user name for the session.
      Parameters:
        `user` - a `StringProperty` or `RegExpProperty`.

    - #### setUser

          public void setUser(java.lang.String user)

      Sets the user name for the session.
      Parameters:
        `user` - the user name.

    - #### getUser

          public StringProperty getUser()

      Returns the user name for the session.
      Returns:
        the user name.

    - #### setCodePage

          public void setCodePage(java.lang.Long codePage)

      Sets the code page in use in this session.
      Parameters:
        `codePage` - the code page.

    - #### getCodePage

          public java.lang.Long getCodePage()

      Returns the code page in use in this session.
      Returns:
        the code page.

    - #### setSystemNumber

          public void setSystemNumber(java.lang.Long systemNumber)

      Sets the system number for this session.
      Parameters:
        `systemNumber` - the system number.

    - #### getSystemNumber

          public java.lang.Long getSystemNumber()

      Returns the system number for this session.
      Returns:
        the system number.