SMILA 1.0 API documentation

org.eclipse.smila.jobmanager
Interface JobRun

All Known Implementing Classes:
JobRunImpl

public interface JobRun

Represents the data for a job run (the JobDefinition, the WorkflowDefinition, WorkerDefinitions, Buckets, etc.).


Method Summary
 Bucket getBucket(java.lang.String bucketName)
           
 java.util.Collection<Bucket> getBuckets()
           
 java.util.Map<java.lang.String,Bucket> getInputBucketsForAction(WorkflowAction action)
           
 java.lang.String getJobName()
           
 java.lang.String getJobRunId()
           
 java.util.Map<java.lang.String,Bucket> getOutputBucketsForAction(WorkflowAction action)
           
 AnyMap getParameters()
           
 WorkflowAction getStartAction()
           
 java.util.Collection<Bucket> getTriggerBuckets()
           
 java.util.Collection<WorkflowAction> getTriggeredActionsForBucket(java.lang.String bucketName)
           
 boolean isTriggeredBy(Bucket triggeringBucket)
           
 

Method Detail

getBucket

Bucket getBucket(java.lang.String bucketName)
Parameters:
bucketName - the bucket's name.
Returns:
the job's Bucket instance for a bucket with the given name

getBuckets

java.util.Collection<Bucket> getBuckets()
Returns:
The Collection of Bucket instances of the JobRun.

getJobName

java.lang.String getJobName()
Returns:
name of job definition

getJobRunId

java.lang.String getJobRunId()
Returns:
The ID of the job run.

getTriggerBuckets

java.util.Collection<Bucket> getTriggerBuckets()
Returns:
persistent input buckets of start action.

isTriggeredBy

boolean isTriggeredBy(Bucket triggeringBucket)
Parameters:
triggeringBucket - a bucket changed by another workflow
Returns:
true if this job run can be triggered by this bucket.

getStartAction

WorkflowAction getStartAction()
Returns:
start action of this job run.

getParameters

AnyMap getParameters()
Returns:
parameters of this job run.

getTriggeredActionsForBucket

java.util.Collection<WorkflowAction> getTriggeredActionsForBucket(java.lang.String bucketName)
Returns:
workflow actions triggered by given bucket.

getInputBucketsForAction

java.util.Map<java.lang.String,Bucket> getInputBucketsForAction(WorkflowAction action)
Returns:
input buckets of given workflow action. (key: input slot name, value: bucket)

getOutputBucketsForAction

java.util.Map<java.lang.String,Bucket> getOutputBucketsForAction(WorkflowAction action)
Returns:
output buckets of given workflow action. (key: input slot name, value: bucket)

SMILA 1.0 API documentation