g-Eclipse
Release 1.0.0

eu.geclipse.core.model
Interface IServiceJobResult

All Known Implementing Classes:
ServiceJobResult, SubmittableServiceJobResult

public interface IServiceJobResult

Interface for single service job result.

Basic implementation of this interface (in form of SOJO bean) is in ServiceJobResult.


Method Summary
 java.lang.String getResourceName()
          Method to access name of the resource (e.g. host's URL) on which service job was run.
 java.lang.String getResultEnum()
          Human-readable service job's result.
 java.lang.String getResultRawData()
          Method to access content of Output > Result > ResultData GTDL element corresponding to this service job result instance.
 java.lang.String getResultSummary()
          Textual interpretation of service job's result.
 java.lang.String getResultType()
          Method to access type of result's data.
 java.util.Date getRunDate()
          Method to access information when corresponding service job was run.
 java.lang.String getSubServiceJobName()
          In case of complex service jobs this method returns sub-job's name.
 

Method Detail

getRunDate

java.util.Date getRunDate()
Method to access information when corresponding service job was run.

Returns:
Date when service job was run.

getResourceName

java.lang.String getResourceName()
Method to access name of the resource (e.g. host's URL) on which service job was run.

Returns:
Name of resource on which service job was run in form of String.

getSubServiceJobName

java.lang.String getSubServiceJobName()
In case of complex service jobs this method returns sub-job's name. If service job is simple, then returned value should be it's name.

Returns:
Name of the sub-service job which was run or name of the simple service job which was run.

getResultType

java.lang.String getResultType()
Method to access type of result's data. Preferably this should be file extension that will determine Eclipse editor in which data should be opened. See also IServiceJob.getInputStreamForResult(IServiceJobResult) and getResultRawData().

Returns:
Extension of file to which service job result's input stream may be saved (preferably without "." at the beginning, e.g. "TXT", not ".TXT").

getResultRawData

java.lang.String getResultRawData()
Method to access content of Output > Result > ResultData GTDL element corresponding to this service job result instance. Returned String is unmodified content taken from GTDL file.

Returns:
String content of Output > Result > ResultData GTDL element.

getResultSummary

java.lang.String getResultSummary()
Textual interpretation of service job's result.

Returns:
String representing human-readable summary of service job's result.

getResultEnum

java.lang.String getResultEnum()
Human-readable service job's result. Represents either the state in which service job is (pending, running...) or - in case when service job was finished - service job's result in form of String (OK, ERROR, WARRNING...).

Returns:
String representing human-readable summary of service job's result.

g-Eclipse
Release 1.0.0