Package com.uc4.api.objects
Class Header
java.lang.Object
com.uc4.api.objects.Header
This class represents information of the header tab of an object.
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Header
(com.uc4.util.XMLDocument doc) Constructs aHeader
using the specified XML document -
Method Summary
Modifier and TypeMethodDescriptionReturns 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.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
-
Header
protected Header(com.uc4.util.XMLDocument doc) Constructs aHeader
using the specified XML document- Parameters:
doc
- XML Document
-
-
Method Details
-
store
Stores data of this object under therequest
element.- Parameters:
doc
- XML Documentrequest
- root element, the header is stored in children elements ofrequest
-
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
-
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
-
setArchiveKey1
Sets the first archive key.- Parameters:
key1
- first archive key.
-
setArchiveKey2
Sets the second archive key.- Parameters:
key2
- second archive key.
-
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
-
getTitle
Returns the title of the object.- Returns:
- title
-
setTitle
Sets the title of the object.- Parameters:
title
- Title
-