Package com.aquima.interactions.process.ds.xml.r8.parsing

Class XmlProcessFlowDS

java.lang.Object

com.aquima.interactions.foundation.report.ReportingDS

com.aquima.interactions.process.ds.xml.r8.parsing.XmlProcessFlowDS

All Implemented Interfaces:

IReportingDS, IProcessFlowDS

public class XmlProcessFlowDS
extends ReportingDS
implements IProcessFlowDS

Xml r8 datasource implementation.

Since:

7.2

Author:

Jon van Leuven

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XmlProcessFlowDS(IInitializationReport report, IXmlNode node)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	This method returns a description of the process.
IMultilingualText	getDisplayName()	This method returns the display name for the process.
GUID	getId()	This method returns the id of the process flow.
String	getName()	This method returns the name of the process flow.
String[]	getRoles()	This method returns an array containing the names of the roles a user should have in order to be allowed to start a process.
GUID	getStartNodeId()	This method returns the ID of the start node.
String	getTypeName()	This method returns the name of the process type.
void	iterateEdges(IProcessEdgeVisitor visitor)	This method should iterate over all the edges of the process flow, and add a data source to the visitor for each one.
void	iterateEventStartDefinitions(IProcessEventStartVisitor visitor)	This method should iterate about all the event start definitions of the process flow.
void	iterateNodes(IProcessNodeVisitor visitor)	This method should iterate over all the nodes of the process flow, and add a data source to the visitor for each one.

Methods inherited from class com.aquima.interactions.foundation.report.ReportingDS

addError, addMessage, getCategory, getReport

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aquima.interactions.foundation.report.IReportingDS

addMessage

Constructor Detail

XmlProcessFlowDS

protected XmlProcessFlowDS(IInitializationReport report,
                           IXmlNode node)

Method Detail

getDescription

public String getDescription()

Description copied from interface: IProcessFlowDS

This method returns a description of the process.

Specified by:

getDescription in interface IProcessFlowDS

Returns:

a description of the process.

getDisplayName

public IMultilingualText getDisplayName()

Description copied from interface: IProcessFlowDS

This method returns the display name for the process.

Specified by:

getDisplayName in interface IProcessFlowDS

Returns:

the display name for the process.

getName

public String getName()

Description copied from interface: IProcessFlowDS

This method returns the name of the process flow.

Specified by:

getName in interface IProcessFlowDS

Returns:

the name of the process flow.

getRoles

public String[] getRoles()

Description copied from interface: IProcessFlowDS

This method returns an array containing the names of the roles a user should have in order to be allowed to start a process. The roles are only relevant for top-level process definitions. If this method does not return any roles, any user is allowed to start the process.

Specified by:

getRoles in interface IProcessFlowDS

Returns:

an array containing the names of the roles a user should have in order to be allowed to start a process.

getStartNodeId

public GUID getStartNodeId()

Description copied from interface: IProcessFlowDS

This method returns the ID of the start node.

Specified by:

getStartNodeId in interface IProcessFlowDS

Returns:

The ID of the start node.

getTypeName

public String getTypeName()

Description copied from interface: IProcessFlowDS

This method returns the name of the process type.

Specified by:

getTypeName in interface IProcessFlowDS

Returns:

the name of the process type.

iterateEdges

public void iterateEdges(IProcessEdgeVisitor visitor)
                  throws InitializationException

Description copied from interface: IProcessFlowDS

This method should iterate over all the edges of the process flow, and add a data source to the visitor for each one.

Specified by:

iterateEdges in interface IProcessFlowDS

Parameters:

visitor - The visitor that should be used to add the edges to.

Throws:

InitializationException - This exception is thrown if the edges could not be initialized.

iterateNodes

public void iterateNodes(IProcessNodeVisitor visitor)
                  throws InitializationException

Description copied from interface: IProcessFlowDS

This method should iterate over all the nodes of the process flow, and add a data source to the visitor for each one.

Specified by:

iterateNodes in interface IProcessFlowDS

Parameters:

visitor - The visitor that should be used to add the nodes to.

Throws:

InitializationException - This exception is thrown if the nodes could not be initialized.

iterateEventStartDefinitions

public void iterateEventStartDefinitions(IProcessEventStartVisitor visitor)
                                  throws InitializationException

Description copied from interface: IProcessFlowDS

This method should iterate about all the event start definitions of the process flow.

Specified by:

iterateEventStartDefinitions in interface IProcessFlowDS

Parameters:

visitor - The visitor to add the start definitions to.

Throws:

InitializationException - This exception is thrown if the start definitions could not be initialized.

getId

public GUID getId()

Description copied from interface: IProcessFlowDS

This method returns the id of the process flow.

Specified by:

getId in interface IProcessFlowDS

Returns:

the id of the process flow, never null.