Package org.silverpeas.core.workflow.engine.datarecord

Class ProcessInstanceRowRecord

java.lang.Object

org.silverpeas.core.workflow.engine.datarecord.AbstractProcessInstanceDataRecord

org.silverpeas.core.workflow.engine.datarecord.ProcessInstanceRowRecord

All Implemented Interfaces:

Serializable, DataRecord

public class ProcessInstanceRowRecord
extends AbstractProcessInstanceDataRecord

ProcessInstanceDataRecord

See Also:

Serialized Form

Field Summary

Fields inherited from class org.silverpeas.core.workflow.engine.datarecord.AbstractProcessInstanceDataRecord

fields, instance, template

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceRowRecord(ProcessInstance instance, String role, String lang)	Builds the data record representation of a process instance.

Method Summary

Modifier and Type	Method	Description
Field	getField(String fieldName)	Returns the named field.
String[]	getFieldNames()	Gets the name of all the fields set in this data record.
ProcessInstance	getFullProcessInstance()
String	getId()	Returns the data record id.
protected ProcessInstanceTemplate	getTemplate(String role, String lang)
boolean	isInError()	Returns error status.
boolean	isInTimeout()	Returns timeout status.
boolean	isLockedByAdmin()	Returns true if this instance is locked by the workflow engine.
boolean	isWorking(User user)	Returns true if the given user is a working on this instance.

Methods inherited from class org.silverpeas.core.workflow.engine.datarecord.AbstractProcessInstanceDataRecord

getField, getField, getLanguage, getResourceReference, getValues, isNew, setId, setLanguage, size

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessInstanceRowRecord

public ProcessInstanceRowRecord(ProcessInstance instance,
                                String role,
                                String lang)
                         throws WorkflowException

Builds the data record representation of a process instance.

Throws:

WorkflowException

Method Detail

getTemplate

protected ProcessInstanceTemplate getTemplate(String role,
                                              String lang)
                                       throws WorkflowException

Specified by:

getTemplate in class AbstractProcessInstanceDataRecord

Throws:

WorkflowException

getId

public String getId()

Returns the data record id.

Specified by:

getId in interface DataRecord

Overrides:

getId in class AbstractProcessInstanceDataRecord

isLockedByAdmin

public boolean isLockedByAdmin()

Returns true if this instance is locked by the workflow engine.

isInError

public boolean isInError()

Returns error status.

isInTimeout

public boolean isInTimeout()

Returns timeout status.

isWorking

public boolean isWorking(User user)

Returns true if the given user is a working on this instance.

getField

public Field getField(String fieldName)
               throws FormException

Returns the named field.

Specified by:

getField in interface DataRecord

Overrides:

getField in class AbstractProcessInstanceDataRecord

Parameters:

fieldName - the name of a field.

Returns:

the named field or, in the case there is no such field, either null or an empty field.

Throws:

FormException - if the field cannot be got.

getFieldNames

public String[] getFieldNames()

Description copied from interface: DataRecord

Gets the name of all the fields set in this data record.

Specified by:

getFieldNames in interface DataRecord

Overrides:

getFieldNames in class AbstractProcessInstanceDataRecord

Returns:

an array with the name of the fields.

getFullProcessInstance

public ProcessInstance getFullProcessInstance()