com.norconex.jef.suite
Interface ISuiteLifeCycleListener

All Known Implementing Classes:
SuiteCompletedMailNotifier, SuiteLifeCycleAdapter

public interface ISuiteLifeCycleListener

Listener for life-cycle activities on a job suite.

Author:
Pascal Essiembre

Method Summary
 void suiteAborted(JobSuite suite)
          Invoked when a job suite is aborted.
 void suiteCompleted(JobSuite suite)
          Invoked when a job suite completes.
 void suiteStarted(JobSuite suite)
          Invoked when a job suite is started.
 void suiteStopped(JobSuite suite)
          Invoked when a job suite is stopped.
 void suiteStopping(JobSuite suite)
          Invoked when a job suite is stopping.
 void suiteTerminatedPrematuraly(JobSuite suite)
          Invoked when a job suite finished executing.
 

Method Detail

suiteStopped

void suiteStopped(JobSuite suite)
Invoked when a job suite is stopped.

Parameters:
suite - job suite

suiteStopping

void suiteStopping(JobSuite suite)
Invoked when a job suite is stopping.

Parameters:
suite - job suite

suiteStarted

void suiteStarted(JobSuite suite)
Invoked when a job suite is started.

Parameters:
suite - job suite

suiteAborted

void suiteAborted(JobSuite suite)
Invoked when a job suite is aborted. This method offers little in terms of error handling. Refer to IErrorHandler to implement error handing.

Parameters:
suite - job suite

suiteTerminatedPrematuraly

void suiteTerminatedPrematuraly(JobSuite suite)
Invoked when a job suite finished executing. A job may finish without having completed successfully.

Parameters:
suite - job suite
Since:
2.0

suiteCompleted

void suiteCompleted(JobSuite suite)
Invoked when a job suite completes. A completed job suite is one where all job executions returned true and progress is at 100%. Given that jobs are implemented correctly, this is usually a good indication of success.

Parameters:
suite - job suite


Copyright © 2007-2013 Norconex Inc.. All Rights Reserved.