Package com.uc4.api.objects
Class Client
- java.lang.Object
-
- com.uc4.api.objects.UC4Object
-
- com.uc4.api.objects.Client
-
public class Client extends UC4Object
This class represents a UC4 CLNT object.
-
-
Constructor Summary
Constructors Constructor Description Client()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clearSettings()
Removes all client settings .java.lang.String
getMibInfo()
Returns the MIB Info.int
getNumberOfSettings()
Returns the number of entries in the UC_CLIENT_SETTINGS variable.java.lang.String
getSetting(java.lang.String name)
Returns the value of a setting ornull
if not found.UC4TimezoneName
getTimezone()
Returns the time zone of this client.Header
header()
Returns the header data of this object.boolean
isExecutable()
Returnstrue
if this Object can be executed.boolean
isMibMonitoring()
Returns the SNMP monitoring setting of this client object.void
setMibInfo(java.lang.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(java.lang.String name, java.lang.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.java.util.Iterator<java.lang.String>
settingNames()
Returns an iterator of all setting names.
-
-
-
Method Detail
-
header
public Header header()
Returns the header data of this object. This is the information of the header tab in the dialog client.- Returns:
- header
-
getTimezone
public UC4TimezoneName 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
public void setTimezone(UC4TimezoneName timezone)
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
public java.lang.String getMibInfo()
Returns the MIB Info.- Returns:
- MIB Info
-
setMibInfo
public void setMibInfo(java.lang.String mibInfo)
Sets the MIB Information of this client object.- Parameters:
mibInfo
- MIB Info
-
getSetting
public java.lang.String getSetting(java.lang.String name)
Returns the value of a setting ornull
if not found.- Parameters:
name
- Name- Returns:
- Value
-
setSetting
public void setSetting(java.lang.String name, java.lang.String value)
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
public java.util.Iterator<java.lang.String> 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.
-
-