org.yawlfoundation.yawl.elements
Class YSpecification

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

public final class YSpecification
extends Object
implements Cloneable, YVerifiable

Objects of this type are a specification of a Workflow checkSchema model in YAWL.

Author:
Lachlan Aldred

Field Summary
static String _loaded
           
static String _unloaded
           
 
Constructor Summary
YSpecification()
           
YSpecification(String specURI)
           
 
Method Summary
 boolean equals(Object other)
           
 String getBetaVersion()
          Deprecated. since v2.0: use getSchemaVersion() instead Gets the version number of this specification's schema (as opposed to the version number of the specification itself).
 YDataValidator getDataValidator()
           
 YDecomposition getDecomposition(String id)
           
 Set<YDecomposition> getDecompositions()
           
 String getDocumentation()
           
 String getID()
           
 YMetaData getMetaData()
           
 String getName()
           
 String getRestoredXML()
           
 YNet getRootNet()
           
 long getRowKey()
           
 YSchemaVersion getSchemaVersion()
           
 YSpecificationID getSpecificationID()
           
 String getSpecVersion()
          Gets the version number of this specification (as opposed to the version number of the specification's schema).
 String getURI()
           
 int hashCode()
           
 void setBetaVersion(String version)
          Deprecated. since v2.0: use setVersion() instead.
 void setDecomposition(YDecomposition decomposition)
           
 void setDocumentation(String documentation)
           
 void setMetaData(YMetaData metaData)
           
 void setName(String name)
           
 void setRootNet(YNet rootNet)
           
 void setRowKey(long key)
           
 void setSchema(String schemaString)
          Sets the data schema for this specification.
 void setVersion(String version)
           
 void setVersion(YSchemaVersion version)
           
 String toXML()
           
 List<YVerificationMessage> verify()
          Internally verify the object against YAWL language semantics and report any errors and/or warnings.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_loaded

public static final String _loaded
See Also:
Constant Field Values

_unloaded

public static final String _unloaded
See Also:
Constant Field Values
Constructor Detail

YSpecification

public YSpecification()

YSpecification

public YSpecification(String specURI)
Method Detail

getRootNet

public YNet getRootNet()

setRootNet

public void setRootNet(YNet rootNet)

getBetaVersion

public String getBetaVersion()
Deprecated. since v2.0: use getSchemaVersion() instead Gets the version number of this specification's schema (as opposed to the version number of the specification itself).

Returns:
the version of the engine that this specification was first designed for.

getSchemaVersion

public YSchemaVersion getSchemaVersion()

getSpecVersion

public String getSpecVersion()
Gets the version number of this specification (as opposed to the version number of the specification's schema).

Returns:
the version of this specification.

setBetaVersion

public void setBetaVersion(String version)
Deprecated. since v2.0: use setVersion() instead.

Sets the version number of the specification.

Parameters:
version -

setVersion

public void setVersion(String version)

setVersion

public void setVersion(YSchemaVersion version)

setSchema

public void setSchema(String schemaString)
               throws YSyntaxException
Sets the data schema for this specification.

Parameters:
schemaString -
Throws:
YSyntaxException

getDataValidator

public YDataValidator getDataValidator()

toXML

public String toXML()

getName

public String getName()

setName

public void setName(String name)

getDocumentation

public String getDocumentation()

setDocumentation

public void setDocumentation(String documentation)

getDecomposition

public YDecomposition getDecomposition(String id)

setDecomposition

public void setDecomposition(YDecomposition decomposition)

getDecompositions

public Set<YDecomposition> getDecompositions()

getURI

public String getURI()

getID

public String getID()

getSpecificationID

public YSpecificationID getSpecificationID()

setMetaData

public void setMetaData(YMetaData metaData)

getMetaData

public YMetaData getMetaData()

equals

public boolean equals(Object other)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

getRowKey

public long getRowKey()

setRowKey

public void setRowKey(long key)

getRestoredXML

public String getRestoredXML()

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
Returns:
a List of YVerificationMessage objects
See Also:
YVerificationMessage


Copyright © 2004-2012 The YAWL Foundation.