Package com.uc4.api.objects
Class FileListVariable
- java.lang.Object
-
- com.uc4.api.objects.FileListVariable
-
public class FileListVariable extends java.lang.Object
This class represents the panel "Variable" of an VARA Object with the source "Filelist".
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
FileListVariable(com.uc4.util.XMLDocument doc)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDirectory()
Returns the directory which is used to get a file list.UC4HostName
getHost()
Returns the name of the Host.UC4ObjectName
getLogin()
Returns the name of the LOGIN object.boolean
isApplyTaskHost()
Returnstrue
if the host name from the task settings should be applied.boolean
isApplyTaskLogin()
Returnstrue
if the LOGIN object from the settings of the currently executed task should be used.void
setApplyTaskHost(boolean applyUserHost)
Sets or clears the check box "Apply Task Host" in the User interface.void
setApplyTaskLogin(boolean applyTaskLogin)
Sets or clears the check box "Apply task Login" in the User interface.void
setDirectory(java.lang.String directory)
Sets the directory for the file list.void
setHost(UC4HostName host)
Sets the Name of the host for the file list.void
setLogin(UC4ObjectName login)
Sets the name of the LOGIN object.protected void
store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element parent)
-
-
-
Method Detail
-
store
protected void store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element parent)
-
getHost
public UC4HostName getHost()
Returns the name of the Host. If the host is not set the return value is an emptyUC4HostName
instance.- Returns:
- Name of the host, never null
-
setHost
public void setHost(UC4HostName host)
Sets the Name of the host for the file list. Ifnull
is passed the field Host will not be set.- Parameters:
host
- Name of the host
-
getLogin
public UC4ObjectName getLogin()
Returns the name of the LOGIN object. If the login is not set the return value is an emptyUC4ObjectName
instance.- Returns:
- Name of the Login object, never null
-
setLogin
public void setLogin(UC4ObjectName login)
Sets the name of the LOGIN object. Ifnull
is passed the field will not be set.- Parameters:
login
- Name of the LOGIN object
-
isApplyTaskHost
public boolean isApplyTaskHost()
Returnstrue
if the host name from the task settings should be applied.- Returns:
- True if the host should be used which set in the settings of the task.
-
setApplyTaskHost
public void setApplyTaskHost(boolean applyUserHost)
Sets or clears the check box "Apply Task Host" in the User interface.- Parameters:
applyUserHost
- iftrue
the host name from the task settings will be used.
-
isApplyTaskLogin
public boolean isApplyTaskLogin()
Returnstrue
if the LOGIN object from the settings of the currently executed task should be used.- Returns:
- true if task login is used
-
setApplyTaskLogin
public void setApplyTaskLogin(boolean applyTaskLogin)
Sets or clears the check box "Apply task Login" in the User interface.- Parameters:
applyTaskLogin
- iftrue
the task login should be used
-
getDirectory
public java.lang.String getDirectory()
Returns the directory which is used to get a file list.- Returns:
- Name of the directory
-
setDirectory
public void setDirectory(java.lang.String directory)
Sets the directory for the file list. The maximum length of the parameterdirectory
is 255 characters.- Parameters:
directory
- Name of the directory
-
-