Package de.aristaflow.adept2.core.client

Interface ADEPT2ClientService

All Superinterfaces:

ActivityManagerService, ADEPT2Service, AdministrationService, CapabilityChecker, ClientService, ExecutionClientService, LocalExecutionClientService, ModellingClientService, ModelViewerProvider, NameResolution, RemoteClient, RemoteExecutionClientService, ServiceAccess, WorklistClientService

All Known Implementing Classes:

MultiplexingClientService

@Deprecated
public interface ADEPT2ClientService
extends ServiceAccess, ActivityManagerService, AdministrationService, ExecutionClientService, ModellingClientService, RemoteExecutionClientService

Deprecated.

This interface is deprecated and will be removed shortly. Use the appropriate specific client service interface (the superclasses of this interface). This interface provides client components/plugins convenient access to their required services. This interface is provided via the client registry or as a service from the bundle context provided under the name of this class (de.aristaflow.adept2.core.client.ADEPT2ClientService). Besides the services, this interface also provides the information needed to use the services, for instance, user information and session tokens. Since a user may be logged in several times at the same client (for instance for several organisational positions), the corresponding client session factories are encapsulated and managed by this interface.

Author:

Ulrich Kreher

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	Description
RichAgent	getActiveAgent()	Deprecated. Gets the currently active agent.
ActivityModelFactory	getActivityModelFactory()	Deprecated. CL_ARCH client service documentation
ActivityRepository	getActivityRepository()	Deprecated. CL_ARCH client service documentation
RichAgent[]	getAuthenticatedAgents()	Deprecated. Gets all authenticated agents of this clients usually this is one agent holding multiple organisational positions.
ExecutionManager	getExecutionManager()	Deprecated.
FilterFactory	getFilterFactory()	Deprecated. CL_ARCH client service documentation
GraphicalModelFactory	getGraphicalModelFactory()	Deprecated. CL_ARCH client service documentation
InstanceChanging	getInstanceChanging()	Deprecated. Gets the interface for changing an instance.
InstanceControl	getInstanceControl()	Deprecated. Gets the interface for controlling an instance.
Class<?>	getModelViewerClass(String pluginID)	Deprecated. Gets the model viewer class for the designated plugin ID that allows type-save access to plugin data at model elements.
OrgModelManager	getOrgModelManager()	Deprecated. CL_ARCH client service documentation
ProcessCheckService	getProcessChecks()	Deprecated.
ProcessImageRenderer	getProcessImageRenderer()	Deprecated.
ProcessManager	getProcessManager()	Deprecated. CL_ARCH client service documentation
ProcessModelFactory	getProcessModelFactory()	Deprecated. CL_ARCH client service documentation
SessionToken	getSessionToken()	Deprecated. Gets a session token for currently active agent and the URIs of this client.
SimpleProcessImageRenderer	getSimpleProcessImageRenderer()	Deprecated.
UpdateManager	getUpdateManager()	Deprecated. Gets the update manager which informs about changes in process objects.

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.AdministrationService

getActivityExecutionControl, getInitTabFactory, getInitTabManager, getProcessManager, getProcessRepository, getResModelManager, getResourceModelFactory

Methods inherited from interface de.aristaflow.adept2.base.sessionmanagement.CapabilityChecker

hasAllCapabilities, hasAllTopLevelCapabilities, hasOneCapability, hasOneTopLevelCapability

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

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

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

getRemoteGUIManager, getRemoteSynchronousActivityStarting

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

getActivityStarting, getAutoStartRuntimeManager, getExecutionControlManager, getExecutionHistory, getExecutionManagerForActivity, getGUIManager, getProcessManagerForInstanceId, getProcessManagerForInstanceLogId, getResModelExplorer, getRuntimeEnvironmentFactory, getRuntimeService, getSynchronousActivityStarting

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

getResModelManager, getResourceModelFactory

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

getComponentType, getFormattedSignature, getHierarchicalInstanceName, getNames, getSimpleInstanceName

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

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

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

getRemoteGUIManager, getRemoteSynchronousActivityStarting

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

getConfiguredPlugin, getConfiguredPlugin, getConfiguredPlugins, getConfiguredPluginTypes, getInterfaceForComponentType, getModelFactory, getService, getService, getServiceOfType

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

getActivityStarting, getAutoStartRuntimeManager, getExecutionControlManager, getExecutionFactory, getProcessManager, getResModelExplorer, getRuntimeManager, getRuntimeService, getSynchronousActivityStarting, getWorklistManager, getWorklistModelFactory

Method Details

getProcessModelFactory

ProcessModelFactory getProcessModelFactory()

Deprecated.

CL_ARCH client service documentation

Specified by:

getProcessModelFactory in interface ActivityManagerService

Specified by:

getProcessModelFactory in interface AdministrationService

Specified by:

getProcessModelFactory in interface LocalExecutionClientService

Specified by:

getProcessModelFactory in interface ModellingClientService

Returns:

The process model factory for this client

getActivityModelFactory

ActivityModelFactory getActivityModelFactory()

Deprecated.

CL_ARCH client service documentation

Specified by:

getActivityModelFactory in interface ActivityManagerService

Returns:

The activity model factory for this client

getFilterFactory

FilterFactory getFilterFactory()

Deprecated.

CL_ARCH client service documentation

Specified by:

getFilterFactory in interface ClientService

Returns:

The factory for creating filters for models for this client.

getGraphicalModelFactory

GraphicalModelFactory getGraphicalModelFactory()

Deprecated.

CL_ARCH client service documentation

Returns:

The factory for creating graphical model elements for this client.

getActiveAgent

RichAgent getActiveAgent()

Deprecated.

Gets the currently active agent. This is normally determined by a drop-down list or the active worklist if worklists are position-specific.

Specified by:

getActiveAgent in interface ClientService

Returns:

The currently active agent.

See Also:

• ClientSessionFactory.getAuthenticatedAgent()

getAuthenticatedAgents

RichAgent[] getAuthenticatedAgents()

Deprecated.

Gets all authenticated agents of this clients usually this is one agent holding multiple organisational positions.

Specified by:

getAuthenticatedAgents in interface ClientService

Returns:

All authenticated agents of this client.

getSessionToken

SessionToken getSessionToken()

Deprecated.

Gets a session token for currently active agent and the URIs of this client.

Specified by:

getSessionToken in interface ClientService

Returns:

A session token for the currently active agent and the URIs of this client.

See Also:

• ClientSessionFactory.getSessionToken(URI[])

getInstanceControl

InstanceControl getInstanceControl()

Deprecated.

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

Specified by:

getInstanceControl in interface AdministrationService

Specified by:

getInstanceControl in interface WorklistClientService

Returns:

An interface allowing to control the execution of an instance.

See Also:

• ExecutionManager.getInstanceControl()

getInstanceChanging

InstanceChanging getInstanceChanging()

Deprecated.

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

Returns:

An interface allowing to control the change of an instance.

See Also:

• ExecutionManager.getInstanceChanging()

getUpdateManager

UpdateManager getUpdateManager()

Deprecated.

Gets the update manager which informs about changes in process objects. This is only an intermediate solution. For now, only a local update manager will be returned since there is no server-side update manager.

Specified by:

getUpdateManager in interface AdministrationService

Specified by:

getUpdateManager in interface ModellingClientService

Returns:

The (local) update manager for this client.

getProcessManager

ProcessManager getProcessManager()

Deprecated.

CL_ARCH client service documentation

Specified by:

getProcessManager in interface AdministrationService

Specified by:

getProcessManager in interface ModellingClientService

Returns:

The process manager for this client

getSimpleProcessImageRenderer

SimpleProcessImageRenderer getSimpleProcessImageRenderer()

Deprecated.

Specified by:

getSimpleProcessImageRenderer in interface AdministrationService

Specified by:

getSimpleProcessImageRenderer in interface LocalExecutionClientService

getProcessImageRenderer

ProcessImageRenderer getProcessImageRenderer()

Deprecated.

Specified by:

getProcessImageRenderer in interface AdministrationService

Specified by:

getProcessImageRenderer in interface LocalExecutionClientService

getOrgModelManager

OrgModelManager getOrgModelManager()

Deprecated.

CL_ARCH client service documentation

Specified by:

getOrgModelManager in interface ActivityManagerService

Specified by:

getOrgModelManager in interface AdministrationService

Specified by:

getOrgModelManager in interface WorklistClientService

Returns:

The org model manager for this client

getActivityRepository

ActivityRepository getActivityRepository()

Deprecated.

CL_ARCH client service documentation

Specified by:

getActivityRepository in interface ActivityManagerService

Returns:

The activity repository for this client

getExecutionManager

ExecutionManager getExecutionManager()

Deprecated.

Specified by:

getExecutionManager in interface AdministrationService

getProcessChecks

ProcessCheckService getProcessChecks()

Deprecated.

Specified by:

getProcessChecks in interface ModellingClientService

getModelViewerClass

Class<?> getModelViewerClass(String pluginID)

Deprecated.

Description copied from interface: ModelViewerProvider

Gets the model viewer class for the designated plugin ID that allows type-save access to plugin data at model elements. If there is no model viewer configured for the designated plugin ID, null will be returned. This ID usually equals the ID of the (service-) plugin that uses the model viewer.

Specified by:

getModelViewerClass in interface ModelViewerProvider

Parameters:

pluginID - The ID of the plugin for which to retrieve a model viewer, this ID is usually the same ID as the one of the (service-) plugin using the plugin data.

Returns:

The model viewer class for the designated plugin ID or null in case there is no model viewer for the designated plugin ID configured.