org.yawlfoundation.yawl.elements.data
Class YParameter

java.lang.Object
  extended by org.yawlfoundation.yawl.elements.data.YVariable
      extended by org.yawlfoundation.yawl.elements.data.YParameter
All Implemented Interfaces:
Cloneable, Comparable<YVariable>, YVerifiable
Direct Known Subclasses:
FormParameter

public class YParameter
extends YVariable
implements Comparable<YVariable>

Author:
Lachlan Aldred Date: 24/09/2003 Time: 15:49:36

Field Summary
static int _ENABLEMENT_PARAM_TYPE
           
static int _INPUT_PARAM_TYPE
           
static int _OUTPUT_PARAM_TYPE
           
 
Fields inherited from class org.yawlfoundation.yawl.elements.data.YVariable
_dataTypeName, _defaultValue, _elementName, _initialValue, _isEmptyTyped, _isUntyped, _name, _namespaceURI, _ordering, _parentDecomposition
 
Constructor Summary
YParameter()
           
YParameter(YDecomposition decomposition, int type)
          creates a parameter
YParameter(YDecomposition decomposition, String type)
          Constructs a parameter using a type string.
 
Method Summary
 boolean bypassesDecompositionStateSpace()
          Returns whether or not the param is used for pure control flow, i.e., the value by passes the decompositions state space.
 String getDirection()
           
 String getParamType()
           
static String getTypeForEnablement()
           
static String getTypeForInput()
           
static String getTypeForOutput()
           
 boolean isEnablement()
           
 boolean isInput()
           
 boolean isOutput()
           
 void setIsCutThroughParam(boolean isCutThroughParam)
          Set whether the param bypasses the decomposition's state space.
 String toString()
           
 String toSummaryXML()
           
 String toXML()
           
 List<YVerificationMessage> verify()
          Internally verify the object against YAWL language semantics and report any errors and/or warnings.
 
Methods inherited from class org.yawlfoundation.yawl.elements.data.YVariable
addAttribute, clone, compareTo, getAttributes, getDataTypeName, getDataTypeNameSpace, getDataTypeNameUnprefixed, getDataTypePrefix, getDefaultValue, getDocumentation, getElementName, getInitialValue, getLogPredicate, getName, getOrdering, getParentDecomposition, getPreferredName, hasAttributes, isEmptyTyped, isMandatory, isOptional, isRequired, isUntyped, isUserDefinedType, setAttributes, setDataTypeAndName, setDefaultValue, setDocumentation, setElementName, setEmptyTyped, setInitialValue, setLogPredicate, setMandatory, setName, setOptional, setOrdering, setParentDecomposition, setUntyped, toXMLGuts, usesElementDeclaration, usesTypeDeclaration
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Field Detail

_INPUT_PARAM_TYPE

public static final int _INPUT_PARAM_TYPE
See Also:
Constant Field Values

_OUTPUT_PARAM_TYPE

public static final int _OUTPUT_PARAM_TYPE
See Also:
Constant Field Values

_ENABLEMENT_PARAM_TYPE

public static final int _ENABLEMENT_PARAM_TYPE
See Also:
Constant Field Values
Constructor Detail

YParameter

public YParameter()

YParameter

public YParameter(YDecomposition decomposition,
                  int type)
creates a parameter

Parameters:
decomposition - the parent decomposition
type - use one of the public static type attributes

YParameter

public YParameter(YDecomposition decomposition,
                  String type)
Constructs a parameter using a type string.

Parameters:
decomposition - the decomposition
type - the parameter type (inputParam /outputParam /enablementParam).
Method Detail

setIsCutThroughParam

public void setIsCutThroughParam(boolean isCutThroughParam)
Set whether the param bypasses the decomposition's state space. Can only be set on an output param.

Parameters:
isCutThroughParam - if yes then true.

getDirection

public String getDirection()

toXML

public String toXML()
Overrides:
toXML in class YVariable

toSummaryXML

public String toSummaryXML()

toString

public String toString()
Overrides:
toString in class YVariable

verify

public List<YVerificationMessage> verify()
Description copied from interface: YVerifiable
Internally verify the object against YAWL language semantics and report any errors and/or warnings.

Specified by:
verify in interface YVerifiable
Overrides:
verify in class YVariable
Returns:
a List of YVerificationMessage objects
See Also:
YVerificationMessage

isInput

public boolean isInput()

isOutput

public boolean isOutput()

isEnablement

public boolean isEnablement()

bypassesDecompositionStateSpace

public boolean bypassesDecompositionStateSpace()
Returns whether or not the param is used for pure control flow, i.e., the value by passes the decompositions state space.

Returns:
true if this parameter bypasses decomposition state space

getTypeForInput

public static String getTypeForInput()

getTypeForOutput

public static String getTypeForOutput()

getTypeForEnablement

public static String getTypeForEnablement()

getParamType

public String getParamType()


Copyright © 2004-2012 The YAWL Foundation.