org.proteios.core
Class PluginResponse

java.lang.Object
  org.proteios.core.PluginResponse

public final class PluginResponse
extends Object

Get the response from a configuration step or execution of a plugin. Use getStatus() to find out the status of the last invokation. See PluginRequest for more information.

Version:

2.0

Author:

Nicklas

Last modified

$Date: 2009-04-09 08:48:11 +0200 (Thu, 09 Apr 2009) $

Method Summary

List<? extends Throwable>	getErrorList() Get a list containing detailed error messages if the status is Response.Status.ERROR.
Job.ExecutionTime	getEstimatedExecutionTime() Get the estimated execution time of the job.
String	getMessage() Get the return message from the plugin.
PluginConfigurationRequest	getNextRequest() Get a PluginRequest object that handles the next request, if status is Response.Status.CONTINUE.
Response.Status	getStatus() Get the status of the response.
void	saveParameters(DbControl dc)

Methods inherited from class java.lang.Object

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

Method Detail

getStatus

public Response.Status getStatus()

Get the status of the response.

getMessage

public String getMessage()

Get the return message from the plugin.

getEstimatedExecutionTime

public Job.ExecutionTime getEstimatedExecutionTime()

Get the estimated execution time of the job. This value is only meaningful after a successful configuration sequence for a job.

getErrorList

public List<? extends Throwable> getErrorList()

Get a list containing detailed error messages if the status is Response.Status.ERROR.

See Also:

getMessage()

getNextRequest

public PluginConfigurationRequest getNextRequest()

Get a PluginRequest object that handles the next request, if status is Response.Status.CONTINUE.

saveParameters

public void saveParameters(DbControl dc)