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 classThis class can be used to construct an instance of the SapGuiDescription class using the builder pattern.protected static classHelper 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.protectedInitializes 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.voidsetApplicationServer(StringProperty applicationServer) Sets the session's application server name.voidsetApplicationServer(String applicationServer) Sets the session's application server name.voidsetClient(StringProperty client) Sets the client selected on the login screen.voidSets the client selected on the login screen.voidsetCodePage(Long codePage) Sets the code page in use in this session.voidsetId(StringProperty id) Sets the session's ID in text format.voidSets the session's ID in text format.voidsetLanguage(StringProperty language) Sets the language the user is working in.voidsetLanguage(String language) Sets the language the user is working in.voidsetName(StringProperty name) Sets the session's name.voidSets the session's name.voidsetSystemName(StringProperty systemName) Sets the name of the SAP system.voidsetSystemName(String systemName) Sets the name of the SAP system.voidsetSystemNumber(Long systemNumber) Sets the system number for this session.voidsetUser(StringProperty user) Sets the user name for the session.voidSets the user name for the session.Methods inherited from class com.hp.lft.sdk.DescriptionBase
cloneTo, getIndex, getIndexType, getObjectProperties, getVRI, setIndex, setIndexType, setObjectProperties, setVRI, setVRIMethods inherited from class com.hp.lft.sdk.PropertiesDescription
cloneMethods inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase
getValueAs, getValueAsStringProperty, insertValueMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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- aStringPropertyorRegExpProperty.
-
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- aStringPropertyorRegExpProperty.
-
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- aStringPropertyorRegExpProperty.
-
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- aStringPropertyorRegExpProperty.
-
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- aStringPropertyorRegExpProperty.
-
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- aStringPropertyorRegExpProperty.
-
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- aStringPropertyorRegExpProperty.
-
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.
-