org.yawlfoundation.yawl.resourcing.codelets
Class SupervisorInfo

java.lang.Object
  extended by org.yawlfoundation.yawl.resourcing.codelets.AbstractCodelet
      extended by org.yawlfoundation.yawl.resourcing.codelets.SupervisorInfo

public class SupervisorInfo
extends AbstractCodelet

Author:
Michael Adams
Created/Last Date:
7/03/2011

Field Summary
 
Fields inherited from class org.yawlfoundation.yawl.resourcing.codelets.AbstractCodelet
_description, XSD_NAMESPACE
 
Constructor Summary
SupervisorInfo()
           
 
Method Summary
 org.jdom.Element execute(org.jdom.Element inData, List<YParameter> inParams, List<YParameter> outParams)
          This method must be implemented to do the work of the codelet.
 List<YParameter> getRequiredParams()
          This method is called when an external entity (such as the YAWL editor) requests the list of parameters required by the codelet.
 
Methods inherited from class org.yawlfoundation.yawl.resourcing.codelets.AbstractCodelet
cancel, getCanonicalClassName, getClassName, getDescription, getInputParameter, getOutputData, getOutputParameter, getParameterValue, getPersist, getRequiredParamsToXML, getValue, getWorkItem, init, resume, setDescription, setInputs, setParameterValue, setPersist, setWorkItem, shutdown, toXML
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SupervisorInfo

public SupervisorInfo()
Method Detail

execute

public org.jdom.Element execute(org.jdom.Element inData,
                                List<YParameter> inParams,
                                List<YParameter> outParams)
                         throws CodeletExecutionException
Description copied from class: AbstractCodelet
This method must be implemented to do the work of the codelet.

Specified by:
execute in class AbstractCodelet
Parameters:
inData - the work item's input data
inParams - the work item's input parameters
outParams - the work item's output parameters
Returns:
a JDOM Element containing the output data generated by this method
Throws:
CodeletExecutionException - if there's any problem getting the required input data, composing the required output data, or performing the execution.

getRequiredParams

public List<YParameter> getRequiredParams()
Description copied from class: AbstractCodelet
This method is called when an external entity (such as the YAWL editor) requests the list of parameters required by the codelet. Override to populate the list. Each parameter should include a name, data type and description as a minimum.

Overrides:
getRequiredParams in class AbstractCodelet
Returns:
the List of parameters required by the codelet.


Copyright © 2004-2012 The YAWL Foundation.