com.plumtree.uiinfrastructure.application.notification
Interface IStartupNotification

All Known Implementing Classes:

DiagnosticRunner

public interface IStartupNotification

Author:

DavidP

Method Summary

java.lang.String[]	getReport() Used to retrieve a comprehensive report of startup errors from the run.
EventLog[]	getReportEventLogs() Used to retrieve a comprehensive report of startup errors from the run.
void	runEnd(ReturnValue initRet) Called when the startup process completes.
boolean	runStart(int numTasks) Called at the beginning of the startup process.
void	setReportEventLogs(EventLog[] eventVector, XPArrayList reportLog) Used to override generated results.
boolean	taskBegin(int taskLoop, java.lang.String taskName, int taskID) Called at the beginning of the task.
boolean	taskEnd(int taskLoop, java.lang.String taskName, int taskID, ReturnValue initRet, IMessage msgs) Called at the end of a specific task.
boolean	taskInitComplete(int taskLoop, java.lang.String taskName, int taskID, int totalNumSteps, ReturnValue initRet, IMessage msgs) Called once task initialization is complete.
boolean	taskStepBegin(int taskLoop, java.lang.String taskName, int taskID, int stepLoop) Called before a specific task step begins.
boolean	taskStepEnd(int taskLoop, java.lang.String taskName, int taskID, int stepLoop, ReturnValue initRet, IMessage msgs) Called at the end of an individual tasks' step.

Method Detail

runStart

boolean runStart(int numTasks)

Called at the beginning of the startup process.

Parameters:

number - of tasks to execute overall

Returns:

true to continue; false to halt immediately

runEnd

void runEnd(ReturnValue initRet)

Called when the startup process completes. Always called, via finally.

taskBegin

boolean taskBegin(int taskLoop,
                  java.lang.String taskName,
                  int taskID)

Called at the beginning of the task. Simple start notification.

Parameters:

taskLoop -

taskName -

taskID -

Returns:

true to continue; false to halt immediately

taskInitComplete

boolean taskInitComplete(int taskLoop,
                         java.lang.String taskName,
                         int taskID,
                         int totalNumSteps,
                         ReturnValue initRet,
                         IMessage msgs)

Called once task initialization is complete. Returns the number of steps in this task. The ReturnValue contains any errors or exceptions that may have occurred during initialization.

Parameters:

taskLoop -

taskName -

taskID -

totalNumSteps -

initRet -

Returns:

true to continue; false to halt immediately

taskStepBegin

boolean taskStepBegin(int taskLoop,
                      java.lang.String taskName,
                      int taskID,
                      int stepLoop)

Called before a specific task step begins. Simply a notifier.

Parameters:

taskLoop -

taskName -

taskID -

stepLoop -

Returns:

true to continue; false to halt immediately

taskStepEnd

boolean taskStepEnd(int taskLoop,
                    java.lang.String taskName,
                    int taskID,
                    int stepLoop,
                    ReturnValue initRet,
                    IMessage msgs)

Called at the end of an individual tasks' step. Always called, with a finally. Exceptions and error return values in the ReturnValue object.

Parameters:

taskLoop -

taskName -

taskID -

stepLoop -

initRet -

Returns:

true to continue; false to halt immediately

taskEnd

boolean taskEnd(int taskLoop,
                java.lang.String taskName,
                int taskID,
                ReturnValue initRet,
                IMessage msgs)

Called at the end of a specific task. Always called, with a finally. The ReturnValue here contains the final result of that task: the integer result code holds what the systemn feels the final result is. Notice that an individual step could fail with error, but the overall task simply show a warning.

Parameters:

taskLoop -

taskName -

taskID -

initRet -

Returns:

true to continue; false to halt immediately

getReport

java.lang.String[] getReport()

Used to retrieve a comprehensive report of startup errors from the run.

Returns:

Ordered array of strings that form a comprehensive startup report

getReportEventLogs

EventLog[] getReportEventLogs()

Used to retrieve a comprehensive report of startup errors from the run.

Returns:

Ordered array of eventlogs that form a comprehensive startup ERROR report

setReportEventLogs

void setReportEventLogs(EventLog[] eventVector,
                        XPArrayList reportLog)

Used to override generated results. Use this to leverage the diagnostic page for non-diagnostic uses such as special error handling

Parameters:

EventLog[] - eventVector: Ordered array of eventlogs that form a comprehensive startup ERROR report