com.silverpeas.processManager
Class ProcessFilter

java.lang.Object
  com.silverpeas.processManager.ProcessFilter

public class ProcessFilter
extends Object

A ProcessFilter is used to select some process from all the process.

Constructor Summary

ProcessFilter(com.silverpeas.workflow.api.model.ProcessModel model, String role, String lang)
Builds a process filter which can be used to select process intance of a given process model.

Method Summary

void	copySharedCriteria(ProcessFilter source) Copy the criteria filled in another context but shared by this filter.
com.silverpeas.form.DataRecord[]	filter(com.silverpeas.workflow.api.instance.ProcessInstance[] allInstances, String role, String lang) Returns only the process instance matching the filter.
String	getCollapse() Returns the collapse status of the filter panel.
com.silverpeas.form.DataRecord	getCriteriaRecord() Get the current criteria.
com.silverpeas.form.Form	getPresentationForm() Returns the form which can be used to fill the filter criteria.
void	setCollapse(String collapse) Set the collapse status of the filter panel.
void	setCriteriaRecord(com.silverpeas.form.DataRecord criteria) Set the current criteria.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessFilter

public ProcessFilter(com.silverpeas.workflow.api.model.ProcessModel model,
                     String role,
                     String lang)
              throws ProcessManagerException

Builds a process filter which can be used to select process intance of a given process model.

Throws:

ProcessManagerException

Method Detail

getPresentationForm

public com.silverpeas.form.Form getPresentationForm()
                                             throws ProcessManagerException

Returns the form which can be used to fill the filter criteria.

Throws:

ProcessManagerException

getCriteriaRecord

public com.silverpeas.form.DataRecord getCriteriaRecord()
                                                 throws ProcessManagerException

Get the current criteria.

Throws:

ProcessManagerException

setCriteriaRecord

public void setCriteriaRecord(com.silverpeas.form.DataRecord criteria)

Set the current criteria.

copySharedCriteria

public void copySharedCriteria(ProcessFilter source)

Copy the criteria filled in another context but shared by this filter. We ignore all the form exception, since this copy is only done to simplify the user life.

getCollapse

public String getCollapse()

Returns the collapse status of the filter panel.

setCollapse

public void setCollapse(String collapse)

Set the collapse status of the filter panel.

filter

public com.silverpeas.form.DataRecord[] filter(com.silverpeas.workflow.api.instance.ProcessInstance[] allInstances,
                                               String role,
                                               String lang)
                                        throws ProcessManagerException

Returns only the process instance matching the filter.

Throws:

ProcessManagerException