Package com.uc4.api.objects
Class ConsoleEvent
java.lang.Object
com.uc4.api.objects.UC4Object
com.uc4.api.objects.ConsoleEvent
- All Implemented Interfaces:
LifecycleSaveAware
Console Event.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Called after an object is saved.console()
Access to the "Console" tab.Returns the content of the "!Process" tab.Returns the content of the "Process" tab.header()
Returns the header data of this object.boolean
Returnstrue
if this Object can be executed.boolean
boolean
protected void
loadContent
(com.uc4.util.XMLDocument doc, ConnectionAttributes session) rollback()
This method provides access to the rollback tab of an executable object.runtime()
Returns runtime information of this job.void
setConsoleType
(ConsoleEventSetting console) Sets the console settings for the specified host type.void
setEventProcess
(String script) Sets the content of the "!Process" tab.void
When this method is called the remains active after the first condition applied.void
When this method is called the EVENT ends when specified condition applies.void
setProcess
(String script) Sets the content of the "Process" tab.protected void
storeContent
(com.uc4.util.XMLDocument doc, Element objectElement, ConnectionAttributes sessionInfo) syncs()
Returns aSyncList
object which contains sync conditions of this object.values()
Methods inherited from class com.uc4.api.objects.UC4Object
docu, getAccess, getIdnr, getModCount, getName, getObjectClient, getType, isOldVersion, load, store, validate
-
Constructor Details
-
ConsoleEvent
public ConsoleEvent()
-
-
Method Details
-
loadContent
-
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, Element objectElement, ConnectionAttributes sessionInfo) -
console
Access to the "Console" tab. The return value should be casted to the a sub class ofConsoleEventSetting
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
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
Returns the header data of this object. This is the information of the header tab in the dialog client.- Returns:
- header
-
syncs
Returns aSyncList
object which contains sync conditions of this object.- Returns:
- sync conditions
-
values
- Returns:
- Variables of this object
-
runtime
Returns runtime information of this job. This corresponds to the "Runtime" tab in the dialog client.- Returns:
- Runtime information
-
getProcess
Returns the content of the "Process" tab.- Returns:
- JCL
-
setProcess
Sets the content of the "Process" tab.- Parameters:
script
- Script
-
getEventProcess
Returns the content of the "!Process" tab.- Returns:
- JCL
-
setEventProcess
Sets the content of the "!Process" tab.- Parameters:
script
- Script
-
eventCalendar
- Returns:
- Calendar condition of this event
-
attributes
- Returns:
- "Attributes" tab of this event
-
isExecutable
public boolean isExecutable()Description copied from class:UC4Object
Returnstrue
if this Object can be executed.- Specified by:
isExecutable
in classUC4Object
- 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 interfaceLifecycleSaveAware
-