Package com.uc4.api.objects
Class XHeader
java.lang.Object
com.uc4.api.objects.XHeader
This class represents information of the header tab of an executable Automation Engine object and SYNC.
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
XHeader
(com.uc4.util.XMLDocument doc) Constructs aXHeader
using the specified XML document -
Method Summary
Modifier and TypeMethodDescriptionboolean
addCustomAttribute
(CustomAttribute customAttr) Adds aCustomAttribute
to the object.Returns anjava.util.Iterator
ofCustomAttribute
.Returns the first archive key.Returns the second archive key.Indicates user, date and time regarding the creation of an object.Indicates user, date and time regarding the most recent modification of the object.Indicates user, date and time regarding the most recent use of the object.Returns the subtype of the object as String.getTitle()
Returns the title of the object.boolean
isActive()
Returnstrue
if active flag is set.void
Removes all Custom Attributes.boolean
removeCustomAttribute
(CustomAttribute customAttr) Removes aCustomAttribute
.void
setActive
(boolean active) Sets the active flag.void
setArchiveKey1
(String key1) Sets the first archive key.void
setArchiveKey2
(String key2) Sets the second archive key.void
Sets the title of the object.protected void
Stores data of this object under therequest
element.
-
Constructor Details
-
XHeader
protected XHeader(com.uc4.util.XMLDocument doc) Constructs aXHeader
using the specified XML document- Parameters:
doc
- XML Document
-
-
Method Details
-
getArchiveKey1
Returns the first archive key. Two freely definable keys may be specified. These are written to the statistics data each time the object is executed. Statistical data may be selected by these archive keys.- Returns:
- first archive key
-
getArchiveKey2
Returns the second archive key. Two freely definable keys may be specified. These are written to the statistics data each time the object is executed. Statistical data may be selected by these archive keys.- Returns:
- second archive key
-
getTitle
Returns the title of the object.- Returns:
- title
-
setArchiveKey1
Sets the first archive key.- Parameters:
key1
- first archive key.
-
setArchiveKey2
Sets the second archive key.- Parameters:
key2
- second archive key.
-
setTitle
Sets the title of the object.- Parameters:
title
- Title
-
getCreated
Indicates user, date and time regarding the creation of an object.- Returns:
- created information
-
getLastModified
Indicates user, date and time regarding the most recent modification of the object.- Returns:
- last modified information
-
getLastUsed
Indicates user, date and time regarding the most recent use of the object. This value is only filled if the LAST_USE setting in the UC_SYSTEM_SETTINGS variable is set.- Returns:
- date and time of last use
-
isActive
public boolean isActive()Returnstrue
if active flag is set.- Returns:
true
if active flag is setfalse
otherwise
-
setActive
public void setActive(boolean active) Sets the active flag.- Parameters:
active
- Active
-
getSubType
Returns the subtype of the object as String. If there is not sub type information available the return value is an empty String.- Returns:
- Sub type or an empty String; never
null
.In case of Variable objects the return values are
- BACKEND
- MULTI
- STATIC
- EXEC
- SQLI_SEC
- SQLI
- SQL
- FILELIST
- SQL_SEC
- XML
Notification objects have the following return values:
- 0 ... Request
- 1 ... Message
- 2 ... Alarm
- 3 ... E-Mail
Sub types of Workflows are:
- IF ... IF-Workflow
- FE ... ForEach Workflow
Events return the following values: TT time event(timer), TS time event(time of execution) FS/FT filesystem, CN console, FA = filesystem automatic
- TT ... time event(timer)
- TS ... time event(time of execution)
- FS ... filesystem
- FT ... filesystem
- CN ... console
- FA ... filesystem automatic
- DT ... database
-
store
Stores data of this object under therequest
element.- Parameters:
doc
- XML Documentrequest
- root element, the header is stored in children elements ofrequest
-
customAttributeIterator
Returns anjava.util.Iterator
ofCustomAttribute
.- Returns:
- Iterator
-
removeAllCustomAttributes
public void removeAllCustomAttributes()Removes all Custom Attributes. -
removeCustomAttribute
Removes aCustomAttribute
.- Parameters:
customAttr
-CustomAttribute
- Returns:
true
if theCustomAttribute
was removed
-
addCustomAttribute
Adds aCustomAttribute
to the object.- Parameters:
customAttr
-CustomAttribute
- Returns:
- true when the attribute was added to the list. false if the list already contained the attribute. The list remains unchanged in this case.
-