Package de.aristaflow.adept2.core.processimagerenderer

Interface ProcessImageRenderer

All Superinterfaces:

ADEPT2Service

public interface ProcessImageRenderer
extends ADEPT2Service

Service interface for getting template and instance process graphs rendered as images. The templates and instances are either retrieved from the process manager or directly from the provided objects.

Author:

Ulrich Kreher

Method Summary

Modifier and Type	Method	Description
ProcessImageData	getInstance(SessionToken session, UUID instanceID, RenderOptions options)	Gets the designated process instance from the process manager as rendered image.
ProcessImageData	getTemplate(SessionToken session, UUID templateID, RenderOptions options)	Gets the designated process template from the process manager as rendered image.
ProcessImageData	renderInstance(SessionToken session, Instance instance, RenderOptions options)	Gets the designated process instance as rendered image.
ProcessImageData	renderTemplate(SessionToken session, Template template, RenderOptions options)	Gets the designated process template as rendered image.

Methods inherited from interface de.aristaflow.adept2.base.service.ADEPT2Service

getLocalUris, getRelease, getRuntimeRequiredServices, getServiceInstanceName, getStartupRequiredServices, getURIs, init, ping, preShutdown, shutdown, start

Method Detail

getTemplate

ProcessImageData getTemplate(SessionToken session,
                             UUID templateID,
                             RenderOptions options)

Gets the designated process template from the process manager as rendered image.

Parameters:

session - The session which is used to check for access rights on this method.

templateID - The ID of the process template to retrieve.

options - Various options for the rendering implementation. Use null to use the defaults of this service.

Returns:

An image representing the designated process template.

getInstance

ProcessImageData getInstance(SessionToken session,
                             UUID instanceID,
                             RenderOptions options)

Gets the designated process instance from the process manager as rendered image.

Parameters:

session - The session which is used to check for access rights on this method.

instanceID - The ID of the process instance to retrieve.

options - Various options for the rendering implementation. Use null to use the defaults of this service.

Returns:

An image representing the designated process instance.

renderTemplate

ProcessImageData renderTemplate(SessionToken session,
                                Template template,
                                RenderOptions options)

Gets the designated process template as rendered image.

Parameters:

session - The session which is used to check for access rights on this method.

template - The process template to render.

options - Various options for the rendering implementation. Use null to use the defaults of this service.

Returns:

An image representing the designated process template.

renderInstance

ProcessImageData renderInstance(SessionToken session,
                                Instance instance,
                                RenderOptions options)

Gets the designated process instance as rendered image.

Parameters:

session - The session which is used to check for access rights on this method.

instance - The process instance to render. This has to contain the corresponding template.

options - Various options for the rendering implementation. Use null to use the defaults of this service.

Returns:

An image representing the designated process instance.