de.aristaflow.adept2.core.client

Interface WorklistClientService

All Superinterfaces:

ADEPT2Service, ClientService, RemoteClient

All Known Subinterfaces:

ADEPT2ClientService, RemoteExecutionClientService

All Known Implementing Classes:

MultiplexingClientService

public interface WorklistClientService
extends ClientService

Nested Class Summary

Nested classes/interfaces inherited from interface de.aristaflow.adept2.core.client.ClientService

ClientService.ActiveAgentChangedListener, ClientService.ServiceStateListener

Method Summary

Modifier and Type	Method and Description
ActivityStarting	getActivityStarting(EBPInstanceReference activity) Gets the interface for (asynchronous) start operations of the designated activity independently from the execution manager holding the activity.
java.net.URI[]	getAutoStartRuntimeManager() Gets the URIs of the runtime manager for autostarting.
ExecutionControlManager	getExecutionControlManager(EBPInstanceReference activity) Gets the execution control manager for the designated activity.
ExecutionFactory	getExecutionFactory()
InstanceControl	getInstanceControl() Gets the interface for controlling an instance.
OrgModelManager	getOrgModelManager() change passwords
ProcessManager	getProcessManager(java.util.UUID instanceID) CL_ARCH client service documentation
RuntimeManager	getRuntimeManager() Gets the runtime manager for this client service, which is usually a local runtime manager.
RuntimeService	getRuntimeService() Gets the runtime service for this client service allowing to execute activities directly by the caller and not in a runtime manager.
SynchronousActivityStarting	getSynchronousActivityStarting(EBPInstanceReference activity) Gets the interface for (synchronous) start operations of the designated activity independently from the execution manager holding the activity.
WorklistManager	getWorklistManager() Gets the worklist manager for logging on and retrieving a worklist and updates from.
WorklistModelFactory	getWorklistModelFactory() CL_ARCH client service documentation

Methods inherited from interface de.aristaflow.adept2.core.client.ClientService

addActiveAgentListener, addGUIListener, addServiceStateListener, agentsChanged, connectAll, disconnectAll, getActiveAgent, getAuthenticatedAgents, getAuthentication, getAvailableLocales, getClusterName, getExecutorService, getFilterFactory, getFormatterFactory, getLicenceManager, getLocalisationFactory, getScheduledExecutorService, getSessionToken, getSessionToken, getSessionToken, getSessionToken, guiSelectionChanged, isConnected, logoff, removeActiveAgentListener, removeGUIListener, removeServiceStateListener, setActiveAgent, setAuthenticatedAgents

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

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

Methods inherited from interface de.aristaflow.adept2.core.client.RemoteClient

getDefaultCharset, getDefaultLocale, getJavaVersion, getLoggedOnAgents, getOperatingSystemArchitecture, getOperatingSystemName, getOperatingSystemVersion, getRuntimeManagerURIs, getUsedLocale, ping, serverReturned, serverShutdown

Method Detail

getWorklistModelFactory

WorklistModelFactory getWorklistModelFactory()

CL_ARCH client service documentation

Returns:

The worklist model factory for this client

getExecutionFactory

ExecutionFactory getExecutionFactory()

getExecutionControlManager

ExecutionControlManager getExecutionControlManager(EBPInstanceReference activity)

Gets the execution control manager for the designated activity. The execution control manager allows to control the execution of the running activity independently from where it is running.

Parameters:

activity - The activity for which to retrieve the execution control manager of the appropriate runtime manager.

Returns:

A manager allowing to control the execution of the designated activity independently from where the execution is located.

See Also:

RuntimeManager.getExecutionControlManager()

getWorklistManager

WorklistManager getWorklistManager()

Gets the worklist manager for logging on and retrieving a worklist and updates from.
It may only be called when online.

Returns:

The worklist manager providing worklist(s) for this client.

getActivityStarting

ActivityStarting getActivityStarting(EBPInstanceReference activity)

Gets the interface for (asynchronous) start operations of the designated activity independently from the execution manager holding the activity.
This is a convenience method for getExecutionManager().getActivityStarting() except that the returned interface also sets the appropriate RuntimeManager-URIs. It may only be called when online.

Parameters:

activity - The activity for which to retrieve the corresponding (asynchronous) start interface of the appropriate execution manager.

Returns:

An interface allowing to perform (asynchronous) start operations on the designated activity.

See Also:

ExecutionManager.getActivityStarting()

getSynchronousActivityStarting

SynchronousActivityStarting getSynchronousActivityStarting(EBPInstanceReference activity)

Gets the interface for (synchronous) start operations of the designated activity independently from the execution manager holding the activity. Synchronous activity starting allows to wait until the application has been fully initialised including its GUI. Afterwards the GUI is returned to the starting component.
This is a convenience method for getRuntimeManager().getSynchronousActivityStarting(). It may only be called when online.

This method needs not be implemented and may return null! In this case use getActivityStarting(EBPInstanceReference).

Parameters:

activity - The activity for which to retrieve the corresponding (synchronous) start interface of the appropriate runtime manager.

Returns:

An interface allowing to perform (synchronous) start operations on the designated activity.

See Also:

RuntimeManager.getSynchronousActivityStarting()

getInstanceControl

InstanceControl getInstanceControl()

Gets the interface for controlling an instance.
This is a convenience method for getExecutionManager().getInstanceControl(). It may only be called when online.

Returns:

An interface allowing to control the execution of an instance.

See Also:

ExecutionManager.getInstanceControl()

getProcessManager

ProcessManager getProcessManager(java.util.UUID instanceID)

CL_ARCH client service documentation

Returns:

The process manager for this client

getOrgModelManager

OrgModelManager getOrgModelManager()

change passwords

Returns:

The org model manager for this client

getRuntimeManager

RuntimeManager getRuntimeManager()

Gets the runtime manager for this client service, which is usually a local runtime manager. This differs from a runtime manager for specific activities, e. g. HTML-activities.

Returns:

The runtime manager for this client service, which is usually a local runtime manager.

getRuntimeService

RuntimeService getRuntimeService()

Gets the runtime service for this client service allowing to execute activities directly by the caller and not in a runtime manager. The caller has complete responsibility for the execution of the activity!

Returns:

The runtime service for this client service allowing to execute activities directly by the caller and not in a runtime manager.

getAutoStartRuntimeManager

java.net.URI[] getAutoStartRuntimeManager()

Gets the URIs of the runtime manager for autostarting. Use this for starting a new instance thus allowing to autostart the first activity. In this case the first activity will be automatically started on the designated runtime manager right after instantiation.

Returns:

The URIs of the runtime manager for autostarting.