org.yawlfoundation.yawl.elements
Class YAWLServiceGateway

java.lang.Object
  extended by org.yawlfoundation.yawl.elements.YDecomposition
      extended by org.yawlfoundation.yawl.elements.YAWLServiceGateway
All Implemented Interfaces:
Cloneable, YVerifiable

public class YAWLServiceGateway
extends YDecomposition
implements YVerifiable

A decomposition associated with a Web Service Gateway.

A web service gateway contains a reference to a YAWL Service, which represents the service that will take responsibility for the execution of any task based on this gateway decomposition.

Since:
0.1
Author:
Lachlan Aldred, Michael Adams (updates for v2.0)
Created/Last Date:
25/09/2003

Field Summary
 
Fields inherited from class org.yawlfoundation.yawl.elements.YDecomposition
_codelet, _data, _id, _manualInteraction, _specification
 
Constructor Summary
YAWLServiceGateway(String id, YSpecification specification)
          Constructs a new web service gateway decomposition.
 
Method Summary
protected  Set<String> getEnablementParameterNames()
          Deprecated. Since 2.0, enablement mappings have no function.
 Map<String,YParameter> getEnablementParameters()
          Deprecated. Since 2.0, enablement mappings have no function.
 YAWLServiceReference getYawlService()
          Gets the YAWL Service associated with this gateway.
 YAWLServiceReference getYawlService(String yawlServiceID)
          Gets the named YAWL Service associated with this gateway.
 void setEnablementParameter(YParameter parameter)
          Deprecated. Since 2.0, enablement mappings have no function.
 void setYawlService(YAWLServiceReference yawlService)
          Sets the YAWL Service associated with this gateway.
 String toXML()
          Outputs this service gateway to an XML representation.
 List<YVerificationMessage> verify()
          Verifies this service gateway decomposition against YAWL semantics.
 
Methods inherited from class org.yawlfoundation.yawl.elements.YDecomposition
addData, addInputParameter, addOutputParameter, assignData, clone, getAttribute, getAttributes, getCodelet, getDocumentation, getID, getInputParameterNames, getInputParameters, getInternalDataDocument, getLogPredicate, getName, getNetDataDocument, getOutputData, getOutputParameterNames, getOutputParameters, getOutputQueries, getRootDataElementName, getSpecification, getStateSpaceBypassParams, getVariableDataByName, initialise, initializeDataStore, requiresResourcingDecisions, restoreData, setAttribute, setAttributes, setCodelet, setDocumentation, setExternalInteraction, setLogPredicate, setName, setOutputExpression, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

YAWLServiceGateway

public YAWLServiceGateway(String id,
                          YSpecification specification)
Constructs a new web service gateway decomposition.

Parameters:
id - the service gateway identifier. Typically this is the same as its name.
specification - the comtaining specification of this service gateway.
Method Detail

verify

public List<YVerificationMessage> verify()
Verifies this service gateway decomposition against YAWL semantics.

Specified by:
verify in interface YVerifiable
Overrides:
verify in class YDecomposition
Returns:
a List of error and/or warning messages. An empty list is returned if the verification is successful.
See Also:
YVerificationMessage

toXML

public String toXML()
Outputs this service gateway to an XML representation.

Overrides:
toXML in class YDecomposition
Returns:
an XML (String) representation of this service gateway

getYawlService

public YAWLServiceReference getYawlService(String yawlServiceID)
Gets the named YAWL Service associated with this gateway.

Parameters:
yawlServiceID - the idnetifier of the service.
Returns:
the Service associated with this gateway iff the service matches the id passed, or null if it doesn't match ori f there is no associated gateway.

getYawlService

public YAWLServiceReference getYawlService()
Gets the YAWL Service associated with this gateway.

Returns:
the Service associated with this gateway, or null if there is no associated gateway.

setYawlService

public void setYawlService(YAWLServiceReference yawlService)
Sets the YAWL Service associated with this gateway.

Parameters:
yawlService - the Service to associate with this gateway.

getEnablementParameters

public Map<String,YParameter> getEnablementParameters()
Deprecated. Since 2.0, enablement mappings have no function.

Gets the enablement parameters.

Returns:
a map of the parameters that become available to yawl services when a task is enabled.

getEnablementParameterNames

protected Set<String> getEnablementParameterNames()
Deprecated. Since 2.0, enablement mappings have no function.

Returns the parameter names for enablement.

Returns:
the set of parameter names.

setEnablementParameter

public void setEnablementParameter(YParameter parameter)
Deprecated. Since 2.0, enablement mappings have no function.

These parameters become available to yawl services when a task is enabled.

Overrides:
setEnablementParameter in class YDecomposition
Parameters:
parameter - the parameter


Copyright © 2004-2012 The YAWL Foundation.