Package com.uc4.api.objects

Class ConsoleEvent

java.lang.Object

com.uc4.api.objects.UC4Object

com.uc4.api.objects.ConsoleEvent

All Implemented Interfaces:

LifecycleSaveAware

public class ConsoleEvent
extends UC4Object
implements LifecycleSaveAware

Console Event.

Constructor Summary

Constructors

Constructor	Description
ConsoleEvent()

Method Summary

Modifier and Type	Method	Description
void	afterSaveObject()	Called after an object is saved.
EventAttributes	attributes()
ConsoleEventSetting	console()	Access to the "Console" tab.
EventCalendar	eventCalendar()
java.lang.String	getEventProcess()	Returns the content of the "!Process" tab.
java.lang.String	getProcess()	Returns the content of the "Process" tab.
XHeader	header()	Returns the header data of this object.
boolean	isExecutable()	Returns true if this Object can be executed.
boolean	isExecutionRepeated()
boolean	isExecutionUntilFirstHit()
protected void	loadContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
Rollback	rollback()	This method provides access to the rollback tab of an executable object.
Runtime	runtime()	Returns runtime information of this job.
void	setConsoleType(ConsoleEventSetting console)	Sets the console settings for the specified host type.
void	setEventProcess(java.lang.String script)	Sets the content of the "!Process" tab.
void	setExecutionRepeated()	When this method is called the remains active after the first condition applied.
void	setExecutionUntilFirstHit()	When this method is called the EVENT ends when specified condition applies.
void	setProcess(java.lang.String script)	Sets the content of the "Process" tab.
protected void	storeContent(com.uc4.util.XMLDocument doc, org.w3c.dom.Element objectElement, ConnectionAttributes sessionInfo)
SyncList	syncs()	Returns a SyncList object which contains sync conditions of this object.
ObjectValues	values()

Methods inherited from class com.uc4.api.objects.UC4Object

docu, getAccess, getIdnr, getModCount, getName, getObjectClient, getType, isOldVersion, load, store, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsoleEvent

public ConsoleEvent()

Method Detail

loadContent

protected void loadContent(com.uc4.util.XMLDocument doc,
                           ConnectionAttributes session)

rollback

public Rollback rollback()

This method provides access to the rollback tab of an executable object.

Returns:

Rollback settings

storeContent

protected void storeContent(com.uc4.util.XMLDocument doc,
                            org.w3c.dom.Element objectElement,
                            ConnectionAttributes sessionInfo)

console

public ConsoleEventSetting console()

Access to the "Console" tab. The return value should be casted to the a sub class of ConsoleEventSetting in order to be able to set or read fields that are specific to a host type.

Returns:

Sub class of ConsoleEventSetting to read or modify the "Console" tab.

setConsoleType

public void setConsoleType(ConsoleEventSetting console)

Sets the console settings for the specified host type.

Parameters:

console - Sub class of ConsoleEventSetting

isExecutionRepeated

public boolean isExecutionRepeated()

Returns:

true if EVENT should remain active after the first condition applied.

isExecutionUntilFirstHit

public boolean isExecutionUntilFirstHit()

Returns:

true if the EVENT ends when specified condition applies.

setExecutionRepeated

public void setExecutionRepeated()

When this method is called the remains active after the first condition applied.

setExecutionUntilFirstHit

public void setExecutionUntilFirstHit()

When this method is called the EVENT ends when specified condition applies.

header

public XHeader header()

Returns the header data of this object. This is the information of the header tab in the dialog client.

Returns:

header

syncs

public SyncList syncs()

Returns a SyncList object which contains sync conditions of this object.

Returns:

sync conditions

values

public ObjectValues values()

Returns:

Variables of this object

runtime

public Runtime runtime()

Returns runtime information of this job. This corresponds to the "Runtime" tab in the dialog client.

Returns:

Runtime information

getProcess

public java.lang.String getProcess()

Returns the content of the "Process" tab.

Returns:

JCL

setProcess

public void setProcess(java.lang.String script)

Sets the content of the "Process" tab.

Parameters:

script - Script

getEventProcess

public java.lang.String getEventProcess()

Returns the content of the "!Process" tab.

Returns:

JCL

setEventProcess

public void setEventProcess(java.lang.String script)

Sets the content of the "!Process" tab.

Parameters:

script - Script

eventCalendar

public EventCalendar eventCalendar()

Returns:

Calendar condition of this event

attributes

public EventAttributes attributes()

Returns:

"Attributes" tab of this event

isExecutable

public boolean isExecutable()

Description copied from class: UC4Object

Returns true if this Object can be executed.

Specified by:

isExecutable in class UC4Object

Returns:

true if the Object can be executed, false if not.

afterSaveObject

public void afterSaveObject()

Description copied from interface: LifecycleSaveAware

Called after an object is saved.

Specified by:

afterSaveObject in interface LifecycleSaveAware