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 SummaryNested 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 SummaryFields inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBaseproperties
- 
Constructor SummaryConstructorsModifierConstructorDescriptionInitializes a new instance of the GuiSessionDescription class.protectedInitializes a new instance of the GuiSessionDescription class using the Builder pattern.
- 
Method SummaryModifier 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.DescriptionBasecloneTo, getIndex, getIndexType, getObjectProperties, getVRI, setIndex, setIndexType, setObjectProperties, setVRI, setVRIMethods inherited from class com.hp.lft.sdk.PropertiesDescriptioncloneMethods inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBasegetValueAs, getValueAsStringProperty, insertValueMethods inherited from class java.lang.Objectequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.hp.lft.sdk.CloneableObjectclone
- 
Constructor Details- 
GuiSessionDescriptionpublic GuiSessionDescription()Initializes a new instance of the GuiSessionDescription class.
- 
GuiSessionDescriptionInitializes a new instance of the GuiSessionDescription class using the Builder pattern.- Parameters:
- init- the Builder pattern.
 
 
- 
- 
Method Details- 
setIdSets the session's ID in text format.- Parameters:
- id- a- StringPropertyor- RegExpProperty.
 
- 
setIdSets the session's ID in text format.- Parameters:
- id- the ID.
 
- 
getIdReturns the ID.- Returns:
- the ID.
 
- 
setNameSets the session's name.- Parameters:
- name- a- StringPropertyor- RegExpProperty.
 
- 
setNameSets the session's name.- Parameters:
- name- the name.
 
- 
getNameReturns the session's name.- Returns:
- the name.
 
- 
setApplicationServerSets the session's application server name.- Parameters:
- applicationServer- a- StringPropertyor- RegExpProperty.
 
- 
setApplicationServerSets the session's application server name.- Parameters:
- applicationServer- the application server name.
 
- 
getApplicationServerReturns the session's application server name.- Returns:
- the application server name.
 
- 
setClientSets the client selected on the login screen.- Parameters:
- client- a- StringPropertyor- RegExpProperty.
 
- 
setClientSets the client selected on the login screen.- Parameters:
- client- the client.
 
- 
getClientReturns the client selected on the login screen.- Returns:
- the client.
 
- 
setLanguageSets the language the user is working in.- Parameters:
- language- a- StringPropertyor- RegExpProperty.
 
- 
setLanguageSets the language the user is working in.- Parameters:
- language- the language.
 
- 
getLanguageReturns the language the user is working in.- Returns:
- the language.
 
- 
setSystemNameSets the name of the SAP system.- Parameters:
- systemName- a- StringPropertyor- RegExpProperty.
 
- 
setSystemNameSets the name of the SAP system.- Parameters:
- systemName- the name.
 
- 
getSystemNameReturns the name of the SAP system.- Returns:
- the name.
 
- 
setUserSets the user name for the session.- Parameters:
- user- a- StringPropertyor- RegExpProperty.
 
- 
setUserSets the user name for the session.- Parameters:
- user- the user name.
 
- 
getUserReturns the user name for the session.- Returns:
- the user name.
 
- 
setCodePageSets the code page in use in this session.- Parameters:
- codePage- the code page.
 
- 
getCodePageReturns the code page in use in this session.- Returns:
- the code page.
 
- 
setSystemNumberSets the system number for this session.- Parameters:
- systemNumber- the system number.
 
- 
getSystemNumberReturns the system number for this session.- Returns:
- the system number.
 
 
-