Package com.uc4.api.objects
Class Client
java.lang.Object
com.uc4.api.objects.UC4Object
com.uc4.api.objects.Client
This class represents a UC4 CLNT object.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Removes all client settings .Returns the MIB Info.int
Returns the number of entries in the UC_CLIENT_SETTINGS variable.getSetting
(String name) Returns the value of a setting ornull
if not found.Returns the time zone of this client.header()
Returns the header data of this object.boolean
Returnstrue
if this Object can be executed.boolean
Returns the SNMP monitoring setting of this client object.void
setMibInfo
(String mibInfo) Sets the MIB Information of this client object.void
setMibMonitoring
(boolean mibMonitoring) Sets the SNMP monitoring setting of this client object.void
setSetting
(String name, String value) Adds a new value or changes the value of an existing setting.void
setTimezone
(UC4TimezoneName timezone) Sets the time zone of this client.Returns an iterator of all setting names.Methods inherited from class com.uc4.api.objects.UC4Object
docu, getAccess, getIdnr, getModCount, getName, getObjectClient, getType, isOldVersion, load, store, validate
-
Constructor Details
-
Client
public Client()
-
-
Method Details
-
header
Returns the header data of this object. This is the information of the header tab in the dialog client.- Returns:
- header
-
getTimezone
Returns the time zone of this client.Time zone default setting for the current client. This time zone applies for all tasks and their corresponding date/time displays for which no time zone was explicitly defined. If no time zone has been chosen, the Automation Engine's UTC applies client-wide.
- Returns:
- Name of the TimeZone object
-
setTimezone
Sets the time zone of this client.Time zone default setting for the current client. This time zone applies for all tasks and their corresponding date/time displays for which no time zone was explicitly defined. If no time zone has been chosen, the Automation Engine's UTC applies client-wide.
- Parameters:
timezone
- Name of the TimeZone object
-
isMibMonitoring
public boolean isMibMonitoring()Returns the SNMP monitoring setting of this client object.- Returns:
- true if SNMP monitoring of this client is enabled
-
setMibMonitoring
public void setMibMonitoring(boolean mibMonitoring) Sets the SNMP monitoring setting of this client object.- Parameters:
mibMonitoring
- true if SNMP monitoring is enabled
-
getMibInfo
Returns the MIB Info.- Returns:
- MIB Info
-
setMibInfo
Sets the MIB Information of this client object.- Parameters:
mibInfo
- MIB Info
-
getSetting
Returns the value of a setting ornull
if not found.- Parameters:
name
- Name- Returns:
- Value
-
setSetting
Adds a new value or changes the value of an existing setting.- Parameters:
name
- Name of the settingvalue
- Value
-
clearSettings
public void clearSettings()Removes all client settings . -
getNumberOfSettings
public int getNumberOfSettings()Returns the number of entries in the UC_CLIENT_SETTINGS variable.- Returns:
- Number of settings
-
settingNames
Returns an iterator of all setting names.- Returns:
- Iterator of setting names
-
isExecutable
public boolean isExecutable()Description copied from class:UC4Object
Returnstrue
if this Object can be executed.- Specified by:
isExecutable
in classUC4Object
- Returns:
- true if the Object can be executed, false if not.
-