org.yawlfoundation.yawl.resourcing.codelets

Class ItemMetaData

java.lang.Object

org.yawlfoundation.yawl.resourcing.codelets.AbstractCodelet

org.yawlfoundation.yawl.resourcing.codelets.ItemMetaData

public class ItemMetaData
extends AbstractCodelet

Example codelet for extracting workitem metadata.

Author:

Michael Adams

Field Summary

Fields inherited from class org.yawlfoundation.yawl.resourcing.codelets.AbstractCodelet

_description, XSD_NAMESPACE

Constructor Summary

Constructors

Constructor and Description
ItemMetaData()

Method Summary

Modifier and Type	Method and Description
Element	execute(Element inData, java.util.List<YParameter> inParams, java.util.List<YParameter> outParams) The implementation of the abstract class that does the work of this codelet.
java.util.List<YParameter>	getRequiredParams() This method is called by the YAWL editor to get 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

ItemMetaData

public ItemMetaData()

Method Detail

execute

public Element execute(Element inData,
                       java.util.List<YParameter> inParams,
                       java.util.List<YParameter> outParams)
                throws CodeletExecutionException

The implementation of the abstract class that does the work of this codelet. Note that calls to most of the base class methods may throw a CodeletExecutionException which should be passed back to the caller,

Specified by:

execute in class AbstractCodelet

Parameters:

inData - The calling workitem's data

inParams - the workitem's input parameters

outParams - the workitem's output parameters

Returns:

the result of the codelet's work as a JDOM Element

Throws:

CodeletExecutionException

getRequiredParams

public java.util.List<YParameter> getRequiredParams()

This method is called by the YAWL editor to get the list of parameters required by the codelet.

Overrides:

getRequiredParams in class AbstractCodelet

Returns:

the List of parameters required by the codelet.