Package com.uc4.api.objects

Class XHeader

java.lang.Object

com.uc4.api.objects.XHeader

public class XHeader
extends java.lang.Object

This class represents information of the header tab of an executable Automation Engine object and SYNC.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XHeader(com.uc4.util.XMLDocument doc)	Constructs a XHeader using the specified XML document

Method Summary

Modifier and Type	Method	Description
boolean	addCustomAttribute(CustomAttribute customAttr)	Adds a CustomAttribute to the object.
java.util.Iterator<CustomAttribute>	customAttributeIterator()	Returns an java.util.Iterator of CustomAttribute.
java.lang.String	getArchiveKey1()	Returns the first archive key.
java.lang.String	getArchiveKey2()	Returns the second archive key.
java.lang.String	getCreated()	Indicates user, date and time regarding the creation of an object.
java.lang.String	getLastModified()	Indicates user, date and time regarding the most recent modification of the object.
java.lang.String	getLastUsed()	Indicates user, date and time regarding the most recent use of the object.
java.lang.String	getSubType()	Returns the subtype of the object as String.
java.lang.String	getTitle()	Returns the title of the object.
boolean	isActive()	Returns true if active flag is set.
void	removeAllCustomAttributes()	Removes all Custom Attributes.
boolean	removeCustomAttribute(CustomAttribute customAttr)	Removes a CustomAttribute.
void	setActive(boolean active)	Sets the active flag.
void	setArchiveKey1(java.lang.String key1)	Sets the first archive key.
void	setArchiveKey2(java.lang.String key2)	Sets the second archive key.
void	setTitle(java.lang.String title)	Sets the title of the object.
protected void	store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request)	Stores data of this object under the request element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XHeader

protected XHeader(com.uc4.util.XMLDocument doc)

Constructs a XHeader using the specified XML document

Parameters:

doc - XML Document

Method Detail

getArchiveKey1

public java.lang.String 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

public java.lang.String 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

public java.lang.String getTitle()

Returns the title of the object.

Returns:

title

setArchiveKey1

public void setArchiveKey1(java.lang.String key1)

Sets the first archive key.

Parameters:

key1 - first archive key.

setArchiveKey2

public void setArchiveKey2(java.lang.String key2)

Sets the second archive key.

Parameters:

key2 - second archive key.

setTitle

public void setTitle(java.lang.String title)

Sets the title of the object.

Parameters:

title - Title

getCreated

public java.lang.String getCreated()

Indicates user, date and time regarding the creation of an object.

Returns:

created information

getLastModified

public java.lang.String getLastModified()

Indicates user, date and time regarding the most recent modification of the object.

Returns:

last modified information

getLastUsed

public java.lang.String 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()

Returns true if active flag is set.

Returns:

true if active flag is set false otherwise

setActive

public void setActive(boolean active)

Sets the active flag.

Parameters:

active - Active

getSubType

public java.lang.String 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

Standard Workflows return an empty String.

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

protected void store(com.uc4.util.XMLDocument doc,
                     org.w3c.dom.Element request)

Stores data of this object under the request element.

Parameters:

doc - XML Document

request - root element, the header is stored in children elements of request

customAttributeIterator

public java.util.Iterator<CustomAttribute> customAttributeIterator()

Returns an java.util.Iterator of CustomAttribute.

Returns:

Iterator

removeAllCustomAttributes

public void removeAllCustomAttributes()

Removes all Custom Attributes.

removeCustomAttribute

public boolean removeCustomAttribute(CustomAttribute customAttr)

Removes a CustomAttribute.

Parameters:

customAttr - CustomAttribute

Returns:

true if the CustomAttribute was removed

addCustomAttribute

public boolean addCustomAttribute(CustomAttribute customAttr)

Adds a CustomAttribute 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.