Package 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
,Cloneable
The description of a SAP GUI Session object.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
This class can be used to construct an instance of the SapGuiDescription class using the builder pattern.protected static class
Helper class for GuiSessionDescription.Builder. -
Field Summary
Fields inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase
properties
-
Constructor Summary
ConstructorsModifierConstructorDescriptionInitializes a new instance of the GuiSessionDescription class.protected
Initializes a new instance of the GuiSessionDescription class using the Builder pattern. -
Method Summary
Modifier and TypeMethodDescriptionReturns the session's application server name.Returns the client selected on the login screen.Returns the code page in use in this session.getId()
Returns the ID.Returns the language the user is working in.getName()
Returns the session's name.Returns the name of the SAP system.Returns the system number for this session.getUser()
Returns the user name for the session.void
setApplicationServer
(StringProperty applicationServer) Sets the session's application server name.void
setApplicationServer
(String applicationServer) Sets the session's application server name.void
setClient
(StringProperty client) Sets the client selected on the login screen.void
Sets the client selected on the login screen.void
setCodePage
(Long codePage) Sets the code page in use in this session.void
setId
(StringProperty id) Sets the session's ID in text format.void
Sets the session's ID in text format.void
setLanguage
(StringProperty language) Sets the language the user is working in.void
setLanguage
(String language) Sets the language the user is working in.void
setName
(StringProperty name) Sets the session's name.void
Sets the session's name.void
setSystemName
(StringProperty systemName) Sets the name of the SAP system.void
setSystemName
(String systemName) Sets the name of the SAP system.void
setSystemNumber
(Long systemNumber) Sets the system number for this session.void
setUser
(StringProperty user) Sets the user name for the session.void
Sets the user name for the session.Methods inherited from class com.hp.lft.sdk.DescriptionBase
cloneTo, getIndex, getIndexType, getObjectProperties, getVRI, setIndex, setIndexType, setObjectProperties, 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 Details
-
GuiSessionDescription
public GuiSessionDescription()Initializes a new instance of the GuiSessionDescription class. -
GuiSessionDescription
Initializes a new instance of the GuiSessionDescription class using the Builder pattern.- Parameters:
init
- the Builder pattern.
-
-
Method Details
-
setId
Sets the session's ID in text format.- Parameters:
id
- aStringProperty
orRegExpProperty
.
-
setId
Sets the session's ID in text format.- Parameters:
id
- the ID.
-
getId
Returns the ID.- Returns:
- the ID.
-
setName
Sets the session's name.- Parameters:
name
- aStringProperty
orRegExpProperty
.
-
setName
Sets the session's name.- Parameters:
name
- the name.
-
getName
Returns the session's name.- Returns:
- the name.
-
setApplicationServer
Sets the session's application server name.- Parameters:
applicationServer
- aStringProperty
orRegExpProperty
.
-
setApplicationServer
Sets the session's application server name.- Parameters:
applicationServer
- the application server name.
-
getApplicationServer
Returns the session's application server name.- Returns:
- the application server name.
-
setClient
Sets the client selected on the login screen.- Parameters:
client
- aStringProperty
orRegExpProperty
.
-
setClient
Sets the client selected on the login screen.- Parameters:
client
- the client.
-
getClient
Returns the client selected on the login screen.- Returns:
- the client.
-
setLanguage
Sets the language the user is working in.- Parameters:
language
- aStringProperty
orRegExpProperty
.
-
setLanguage
Sets the language the user is working in.- Parameters:
language
- the language.
-
getLanguage
Returns the language the user is working in.- Returns:
- the language.
-
setSystemName
Sets the name of the SAP system.- Parameters:
systemName
- aStringProperty
orRegExpProperty
.
-
setSystemName
Sets the name of the SAP system.- Parameters:
systemName
- the name.
-
getSystemName
Returns the name of the SAP system.- Returns:
- the name.
-
setUser
Sets the user name for the session.- Parameters:
user
- aStringProperty
orRegExpProperty
.
-
setUser
Sets the user name for the session.- Parameters:
user
- the user name.
-
getUser
Returns the user name for the session.- Returns:
- the user name.
-
setCodePage
Sets the code page in use in this session.- Parameters:
codePage
- the code page.
-
getCodePage
Returns the code page in use in this session.- Returns:
- the code page.
-
setSystemNumber
Sets the system number for this session.- Parameters:
systemNumber
- the system number.
-
getSystemNumber
Returns the system number for this session.- Returns:
- the system number.
-