com.ibm.websphere.ci
Interface CIWork

All Superinterfaces:
java.lang.Runnable, commonj.work.Work

public interface CIWork
extends commonj.work.Work

Interface implemented by classes that provide the logic for compute-intensive job steps.

Each compute-intensive job step indicates the name of the class that provides the logic for the job. The specified class must implement this interface. The compute-intensive execution environment creates an instance of the class, sets the properties for the job step and arranges for the Work.run() method to be invoked by a WorkManager thread. The job step is considered to have completed successfully when the Work.run() method returns without throwing an exception. If the job is cancelled, the Work.release() method is invoked.

In addition to satisfying the constraints placed by the Work interface and implementing the methods below, objects that implement CIWork must adhere to the following:


Method Summary
 java.util.Map getProperties()
          Returns the job step properties.
 void setProperties(java.util.Map props)
          Sets the job step properties passed by the submitter.
 
Methods inherited from interface commonj.work.Work
isDaemon, release
 
Methods inherited from interface java.lang.Runnable
run
 

Method Detail

setProperties

void setProperties(java.util.Map props)
Sets the job step properties passed by the submitter. The keys in the Map will always be java.lang.String objects. The types of the value objects will depend on how the job was specified. For jobs submitted using xJCL, the values will always be java.lang.String objects.

Parameters:
props - job step properties

getProperties

java.util.Map getProperties()
Returns the job step properties. The returned Map is only guaranteed to be readable -- callers of this method should not attempt to update the returned Map.

Returns:
job step properties