Package com.e1c.g5.dt.internal.applications.ui

Class ApplicationUiSupport

java.lang.Object

com.e1c.g5.dt.internal.applications.ui.ApplicationUiSupport

All Implemented Interfaces:

IApplicationUiSupport

public class ApplicationUiSupport
extends Object
implements IApplicationUiSupport

The IApplicationUiSupport implementation.

Applications are deemed to be started if their lifecycle state (IApplicationManager.getLifecycleState(com.e1c.g5.dt.applications.ILifecycleAware)) is either LifecycleState.STARTED (as needed for applications on standalone server) or LifecycleState.UNKNOWN (as always is for infobase applications, see InfobaseApplicationProvisionDelegate).

Publishes the following metrics under com.e1c.g5.dt.applications.ui/event/ensureUpdated. using provided IMonitoringEventDispatcher:

• userDecision:(update|skip|cancel) - user choice when an application had to be updated.
• updated.userDecision - an application was updated according with user decision.
• notUpdated.REASON - an application was not updated because of the specified reason which could be one of the following:
  • alreadySynchronized.ibChanges:(resolved|notResolved) - no update was needed. The value shows if infobase-side changes were resolved (absent or imported) or not (present but rejected).
  • userDecision:(skip|cancel) - an user has decided not to update an application. The value shows if an user has decided just to skip an update or cancel whole operation.
  • updateInProgress - an application is already being updated right now.

Constructor Summary

Constructors

Constructor	Description
ApplicationUiSupport()

Method Summary

Modifier and Type	Method	Description
org.eclipse.core.runtime.IStatus	ensureUpdated(org.eclipse.swt.widgets.Shell shell, IApplication application, PublishKind publishKind, ExecutionContext executionContext, String mode, org.eclipse.core.runtime.IProgressMonitor monitor)	Updates application if necessary.
void	showAndUpdateView()	Shows and updates Applications view.
void	showErrorDialog(org.eclipse.swt.widgets.Shell shell, String message, Throwable cause)	Shows standard error dialog with message compound from message and messages from cause and its parent causes

Methods inherited from class java.lang.Object

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

Constructor Details

ApplicationUiSupport

public ApplicationUiSupport()

Method Details

ensureUpdated

public org.eclipse.core.runtime.IStatus ensureUpdated(org.eclipse.swt.widgets.Shell shell,
 IApplication application,
 PublishKind publishKind,
 ExecutionContext executionContext,
 String mode,
 org.eclipse.core.runtime.IProgressMonitor monitor)
                                               throws org.eclipse.core.runtime.CoreException

Description copied from interface: IApplicationUiSupport

Updates application if necessary.

1. If application is not prepared yet then it is prepared using the specified desired launch mode. As to what preparing application means see IApplicationManager.prepare(IApplication, String, ExecutionContext, IProgressMonitor). If application has already been launched but using a different mode then it is implementation specific as to what happens.
2. Then application state is checked to determine if infobase needs to be updated.
3. If updates are needed then the specified update mode is used to perform the update. An implementation might ask user for a confirmation to update infobase.

Specified by:

ensureUpdated in interface IApplicationUiSupport

Parameters:

shell - Shell to be used to display messages to user. If the context does not yet has ExecutionContext.ACTIVE_SHELL_NAME specified then the shell will be propagated to the context. Must not be null.

application - Application to check and update. Must not be null.

publishKind - Update type to use when the application has to be updated. Must not be null.

executionContext - Context to be used for checking application state and updating it if necessary. Must not be null.

mode - Desired application launch mode: either ILaunchManager.RUN_MODE or ILaunchManager.DEBUG_MODE. Must not be null.

monitor - the progress monitor or null if not needed

Returns:

IStatus.OK if operation should proceed (no update was needed, application was updated or user has decided not to update) or IStatus.CANCEL if operation has been cancelled or cannot proceed (unresolved conflict with infobase). Never null.

Throws:

org.eclipse.core.runtime.CoreException - If application state cannot be determined, infobase cannot be checked for changes, or application launch or update fails.

showAndUpdateView

public void showAndUpdateView()
                       throws org.eclipse.core.runtime.CoreException

Description copied from interface: IApplicationUiSupport

Shows and updates Applications view.

Specified by:

showAndUpdateView in interface IApplicationUiSupport

Throws:

org.eclipse.core.runtime.CoreException - if show or update fails

showErrorDialog

public void showErrorDialog(org.eclipse.swt.widgets.Shell shell,
 String message,
 Throwable cause)

Description copied from interface: IApplicationUiSupport

Shows standard error dialog with message compound from message and messages from cause and its parent causes

Specified by:

showErrorDialog in interface IApplicationUiSupport

Parameters:

shell - actual Shell for open error dialog, cannot be null

message - error message to show, cannot be null

cause - cause of error dialog, can be null, if is is not null all messages it and its parent cause will be added to show error message