com.whitestein.lsps.visualization

Interface VisualizationServiceLocal

All Known Implementing Classes:

VisualizationServiceBean

public interface VisualizationServiceLocal

This service defines methods which give access to visualization data of diagrams.

Author:

jsa

Method Summary

Modifier and Type	Method and Description
List<DiagramInfo>	findDiagrams(long moduleId, String elementId) Finds diagrams for an element.
String	getDiagram(String modelId, String diagramUri) Gets a process model diagram as a JSON string.
ModuleResources	getModuleResources(long moduleId) Finds resources defined in a specific module.
String	getRuntimeDiagram(long modelInstanceId, Long processInstanceId, String diagramUri) Gets a runtime diagram as JSON string for the given process instance.

Method Detail

getDiagram

String getDiagram(String modelId,
                  String diagramUri)

Gets a process model diagram as a JSON string. The diagram URI allows to request any diagram in the given model.

Parameters:

modelId - the identifier of the module in which the process is defined

diagramUri - the URI to the diagram

Returns:

a JSON string representing the process diagram

getRuntimeDiagram

String getRuntimeDiagram(long modelInstanceId,
                         Long processInstanceId,
                         String diagramUri)

Gets a runtime diagram as JSON string for the given process instance. The diagram contains also the current runtime states information represented by different colors.

It might happen that there is no process instance for the requested diagram. This is true if for example user tries to click on a subprocess but the subprocess hasn't been executed yet. But is is a valid request to display a runtime diagram for a not executed subprocess. In such a case this method should return a diagram with disabled elements.

Parameters:

modelInstanceId - the identifier of the model instance

processInstanceId - the identifier of the process instance (optional)

diagramUri - the identifier of the diagram which should be displayed

Returns:

a JSON string representing the process instance diagram

findDiagrams

List<DiagramInfo> findDiagrams(long moduleId,
                               String elementId)

Finds diagrams for an element. This method tries to find first ancestor of the element which is a diagram container and then returns information about all diagrams contained by the diagram container.

Parameters:

moduleId - the identifier of the module

elementId - the identifier of the element

Returns:

a list of diagram information contained by the first ancestor of the element which represents a diagram container.

getModuleResources

ModuleResources getModuleResources(long moduleId)

Finds resources defined in a specific module.

Parameters:

moduleId - the identifier of the module which should be searched for resources

Returns:

resources of the given module