public interface IContainer extends IKAction
This interface is the basic unit of scheduling. It contains a group of actions that have some logical connection.
For example, if a group of actions are to be executed only if a condition evaluates to 'true', the actions to be performed are placed together inside a container. The container is then passed to the branching action.
Containers are intended to be nested for use by various flow-control actions.
ABANDONED, DP_ENCRYPTED_VALUES_KEY, EXECUTING, FINISHED, HANDLETIMER, SEMWAIT, SLEEPING, Status, UNSTARTED
HISTORY_ALL, HISTORY_NONE, HISTORY_PAGES, HISTORY_REQUESTS, HISTORY_SCHEDULE, LOG_ALL, LOG_CONFIG, LOG_FINE, LOG_FINER, LOG_FINEST, LOG_INFO, LOG_NONE, LOG_SEVERE, LOG_WARNING, STATISTIC_ALL, STATISTIC_NONE, STATISTIC_PAGES
STORAGE_ENV, STORAGE_LOCAL, STORAGE_SYSTEM, STORAGE_USER
Modifier and Type | Method and Description |
---|---|
void |
add(IKAction action)
Add an action to this container.
|
void |
addCatch(IKExceptionHandler handler)
Add an exception handler action to the container.
|
void |
addFinally(IKAction initialAction)
Adds a KAction to the FINALLY clause for this container.
|
void |
addInitially(IKAction initialAction)
Adds a KAction to the INITIALLY clause for this container.
|
IKAction |
current() |
void |
finish(IKAction child)
Indicate that processing has finished for this action.
|
IKAction |
get(String actionName) |
Iterator |
getActions() |
IKAction[] |
getActionsArray() |
int |
getChildCount() |
com.ibm.rational.test.lt.kernel.action.impl.CompoundTest |
getCompoundTest() |
com.ibm.rational.test.lt.kernel.action.impl.KScript |
getKScript() |
String |
getParentHistoryId() |
org.eclipse.hyades.test.common.event.TypedEvent |
getStartEvent() |
String |
getStartHistoryId() |
org.eclipse.hyades.test.common.event.TypedEvent |
getStopEvent() |
int |
getThinkScheme() |
com.ibm.rational.test.lt.kernel.action.impl.UserGroup |
getUserGroup() |
com.ibm.rational.test.lt.kernel.engine.impl.VirtualUser |
getVirtualUser() |
boolean |
isAllowChildrenToPageTestLog() |
Object |
loadTest(IContainer parent,
String projectName,
String className,
String id)
Loads a test with the specified class name using a custom class
loader for the project specified.
|
IKAction |
next() |
String |
nextHistoryId() |
IKAction |
previous() |
void |
recordChildExecutionTime(IKAction child) |
void |
registerChildVerdict(int verdict) |
void |
registerChildVerdict(int verdict,
int count) |
void |
registerChildVerdict(String id,
int verdict)
informs the parent of a child verdict
|
void |
registerChildVerdict(String id,
int verdict,
int count)
informs the parent of 1 or more child verdicts
|
boolean |
remove(IKAction action)
Remove an action from this container.
|
boolean |
rollUpVerdicts()
reports verdicts summarizing the verdicts reported by the container's children
See KContainer: reportingRollUp(), passThroughRollUp(), and nullRollUp() for three
"standard" algorithms.
|
void |
setAllowChildrenToPageTestLog(boolean ok)
indicates that it is safe (or not) for the testLog loading code in the workbench to unload the child testLog
events associated with this container's testLog start event during runtime processing.
|
void |
setStartHistoryId(String id)
Saves the execution history event id for the container's start event
The container's start event is the parent event for all events generated by the container
This id is not null iff the container reported a start event.
|
void |
stopChildren(boolean actGlobally)
stops all currently running child actions and prevents new ones from starting.
|
IKAction |
verifyParentRelationships()
Verify parent/child relationships in this container and below
This method was addded in order to address the possibility that
an action could have been added to multiple containers.
|
abandon, addEventBehavior, blocked, execute, executeAction, executionTime, findDataArea, finish, getBlockedTimeout, getHistory, getHistoryType, getId, getName, getParent, getResultInteger, getResultObject, getResultString, getRtbEnabled, getStatTree, getStopRequested, getSubsystem, getTimeoutDuration, getTimeoutScheme, getVirtualUserName, getWorkerThread, hasFinished, hasStarted, isRunning, reset, setBlockedTimeout, setDispatchingAction, setHistory, setHistoryType, setId, setResultInteger, setResultObject, setResultString, setResultString, setRtbEnabled, setStatTree, start, status, stop, stop, stopAction
addCounter, getCounter, getCounters, resetCounters
getHistoryLevel, getHistoryLevel, getLogLevel, getStatisticsLevel, getVirtualUserGUID, log, log, log, log, reportEvent, reportEvent, reportEvent, reportMessage, reportMessage, reportMessage, reportVerdict, reportVerdict, reportVerdict, reportVerdict, reportVerificationPoint, reportVerificationPoint, reportVerificationPoint, reportVerificationPoint, reportVerificationPoint, reportVerificationPoint, wouldARM, wouldLog, wouldReportHistory, wouldReportHistory, wouldReportStatistics
acquire, availablePermits, getQueue, getQueueLength, reducePermits, release, release, toString, tryAcquire, tryAcquire
getARM, getLoopControl, getPDLogManager, getStatisticsManager, getTestLogManager, getTime, getTransaction, getValue, setValue
void add(IKAction action)
Adds a non-dispatched, non-running action.
action
- to addboolean remove(IKAction action)
Removes an action.
action
- to removetrue
if the item was on the list
false
if the item was not on the listIterator getActions()
IKAction[] getActionsArray()
int getChildCount()
IKAction next()
IKAction previous()
IKAction current()
IKAction verifyParentRelationships()
This method was addded in order to address the possibility that an action could have been added to multiple containers. Doing so would reset the parent container to the last one to which it was added. This would result in some containers never receiving the proper number of 'finish(...)' calls, hanging the execution.
void finish(IKAction child)
Note: The implication here is that the action is complete and the container should continue on to the next action in the container.
child
- the child action that has finishedActionException
- if the action has not been startedIKAction.execute()
,
IKAction.start()
,
IKAction.isRunning()
void recordChildExecutionTime(IKAction child)
String nextHistoryId()
void setStartHistoryId(String id)
id
- String getStartHistoryId()
String getParentHistoryId()
org.eclipse.hyades.test.common.event.TypedEvent getStartEvent()
org.eclipse.hyades.test.common.event.TypedEvent getStopEvent()
com.ibm.rational.test.lt.kernel.engine.impl.VirtualUser getVirtualUser()
com.ibm.rational.test.lt.kernel.action.impl.UserGroup getUserGroup()
com.ibm.rational.test.lt.kernel.action.impl.CompoundTest getCompoundTest()
boolean rollUpVerdicts()
void registerChildVerdict(String id, int verdict, int count)
id
- comma seperated list of idsverdict
- count
- void registerChildVerdict(String id, int verdict)
id
- verdict
- void registerChildVerdict(int verdict, int count)
void registerChildVerdict(int verdict)
void setAllowChildrenToPageTestLog(boolean ok)
ok
- boolean isAllowChildrenToPageTestLog()
void stopChildren(boolean actGlobally)
actGlobally
- indicates whether the stop applies to other engines (for schedules and userGroups)void addCatch(IKExceptionHandler handler)
handler
- An IKExceptionHandler that pairs an exception class with a KAction to run when the exception occurs.void addFinally(IKAction initialAction)
finalAction
- void addInitially(IKAction initialAction)
initialAction
- Object loadTest(IContainer parent, String projectName, String className, String id)
parent
- projectName
- className
- id
- com.ibm.rational.test.lt.kernel.action.impl.KScript getKScript()
int getThinkScheme()
© Copyright IBM Corp. 2013. All rights reserved.