org.yawlfoundation.yawl.scheduling

Class Case

java.lang.Object

org.yawlfoundation.yawl.scheduling.Case

public class Case
extends java.lang.Object

Represents a YAWL case

Author:

sga, jku

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	caseId

Constructor Summary

Constructors

Constructor and Description
Case(java.lang.String id)
Case(java.lang.String caseId, java.lang.String caseName, java.lang.String caseDescription, Document rup)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCaseDescription()
java.lang.String	getCaseId()
java.lang.String	getCaseName()
java.util.List<Element>	getData()
java.lang.String	getDescription()
long	getId()
java.lang.String	getParentNetId(java.lang.String id) Returns ID of parent net
Document	getRUP()
java.lang.String	getRupAsString()
java.lang.String	getSavedBy()
java.lang.String	getText(int depth, java.lang.String xPath) Gets the value for an XPath expression for an Element at a specified depth in the case's data
java.lang.String	getText(java.lang.String xPath) Traverses case data attempting to find an element that returns a non-null result for an XPath expression
long	getTimestamp()
boolean	isActive()
java.lang.String	readCaseData(java.lang.String caseId) Read case data from the YAWL work queue
void	setActive(boolean active)
void	setCaseId(java.lang.String id)
void	setCaseName(java.lang.String name)
void	setDescription(java.lang.String desc)
void	setId(long id)
void	setRUP(Document doc)
void	setRupAsString(java.lang.String ras)
void	setSavedBy(java.lang.String saver)
void	setTimestamp(long time)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

caseId

protected java.lang.String caseId

Constructor Detail

Case

public Case(java.lang.String id)

Case

public Case(java.lang.String caseId,
            java.lang.String caseName,
            java.lang.String caseDescription,
            Document rup)

Method Detail

getId

public long getId()

setId

public void setId(long id)

getCaseId

public java.lang.String getCaseId()

setCaseId

public void setCaseId(java.lang.String id)

getCaseName

public java.lang.String getCaseName()

setCaseName

public void setCaseName(java.lang.String name)

getCaseDescription

public java.lang.String getCaseDescription()

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String desc)

getRUP

public Document getRUP()

setRUP

public void setRUP(Document doc)

getSavedBy

public java.lang.String getSavedBy()

setSavedBy

public void setSavedBy(java.lang.String saver)

isActive

public boolean isActive()

setActive

public void setActive(boolean active)

getTimestamp

public long getTimestamp()

setTimestamp

public void setTimestamp(long time)

getRupAsString

public java.lang.String getRupAsString()

setRupAsString

public void setRupAsString(java.lang.String ras)

getData

public java.util.List<Element> getData()

readCaseData

public java.lang.String readCaseData(java.lang.String caseId)
                              throws java.io.IOException

Read case data from the YAWL work queue

Parameters:

caseId - the case to get the data for

Returns:

the net-level data for the case id

Throws:

java.io.IOException - if the case data can't be retrieved from the engine

See Also:

readCaseData()

getParentNetId

public java.lang.String getParentNetId(java.lang.String id)

Returns ID of parent net

If the Id passed as the argument is a root ID, it will be returned unchanged.

Parameters:

id - the id of a child net

Returns:

the id of its parent

getText

public java.lang.String getText(int depth,
                                java.lang.String xPath)

Gets the value for an XPath expression for an Element at a specified depth in the case's data

Parameters:

depth - the depth of the Element to use from the case data

xPath - the XPath expression

Returns:

the result of the XPath evaluation, or null if the depth exceeds the depth of the case data's Elements, or if the XPath expression evaluates to null, or if the Element result of the XPath expression contains no text

getText

public java.lang.String getText(java.lang.String xPath)

Traverses case data attempting to find an element that returns a non-null result for an XPath expression

Parameters:

xPath - the expression to evaluate

Returns:

the text matching the XPath evaluation, or null if no match is found