com.mindtree.techworks.insight.releng.mvn.nsis.model
Class Functions

java.lang.Object
  com.mindtree.techworks.insight.releng.mvn.nsis.model.Functions

All Implemented Interfaces:

java.io.Serializable

public class Functions
extends java.lang.Object
implements java.io.Serializable

Contains information about init functions for the installer and the uninstaller.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Functions()

Method Summary

FunctionDefinition	getInstallAppRunCheckFn() Get user defined function to check if the application is running when the installer starts.
java.lang.String	getMultiInstallerInstanceMessage() Get the message to display when more than one instance of the installer is running.
java.lang.String	getPrevVerPresentPrompt() Get the prompt to the user when a previous version of the application is found.
java.lang.String	getPrevVerUninstallAbortMsg() Get message displayed when the uninstall of the previous version is aborted by the user.
java.lang.String	getPrevVerUninstallFailMsg() Get message displayed when the uninstall of the previous version fails.
FunctionDefinition	getUninstallAppRunCheckFn() Get user defined function to check if the application is running when the uninstaller starts.
java.lang.String	getUninstallConfirmPrompt() Get the prompt displayed to the user when the uninstaller is invoked.
java.lang.String	getUninstallSuccessMsg() Get message displayed after successfully uninstalling the application.
boolean	isUninstallPrevVer() Get if set to true, the installer will try to identify and uninstall any previous version of the application.
boolean	isUseMutexForInstaller() Get indicates if a mutex is to be used to ensure a single instance of the installer.
void	setInstallAppRunCheckFn(FunctionDefinition installAppRunCheckFn) Set user defined function to check if the application is running when the installer starts.
void	setMultiInstallerInstanceMessage(java.lang.String multiInstallerInstanceMessage) Set the message to display when more than one instance of the installer is running.
void	setPrevVerPresentPrompt(java.lang.String prevVerPresentPrompt) Set the prompt to the user when a previous version of the application is found.
void	setPrevVerUninstallAbortMsg(java.lang.String prevVerUninstallAbortMsg) Set message displayed when the uninstall of the previous version is aborted by the user.
void	setPrevVerUninstallFailMsg(java.lang.String prevVerUninstallFailMsg) Set message displayed when the uninstall of the previous version fails.
void	setUninstallAppRunCheckFn(FunctionDefinition uninstallAppRunCheckFn) Set user defined function to check if the application is running when the uninstaller starts.
void	setUninstallConfirmPrompt(java.lang.String uninstallConfirmPrompt) Set the prompt displayed to the user when the uninstaller is invoked.
void	setUninstallPrevVer(boolean uninstallPrevVer) Set if set to true, the installer will try to identify and uninstall any previous version of the application.
void	setUninstallSuccessMsg(java.lang.String uninstallSuccessMsg) Set message displayed after successfully uninstalling the application.
void	setUseMutexForInstaller(boolean useMutexForInstaller) Set indicates if a mutex is to be used to ensure a single instance of the installer.

Methods inherited from class java.lang.Object

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

Constructor Detail

Functions

public Functions()

Method Detail

getInstallAppRunCheckFn

public FunctionDefinition getInstallAppRunCheckFn()

Get user defined function to check if the application is running when the installer starts. If the value is not specified the check is not performed.

Returns:

FunctionDefinition

getMultiInstallerInstanceMessage

public java.lang.String getMultiInstallerInstanceMessage()

Get the message to display when more than one instance of the installer is running.

Returns:

String

getPrevVerPresentPrompt

public java.lang.String getPrevVerPresentPrompt()

Get the prompt to the user when a previous version of the application is found. This values is used only when uninstallPreviousVersion is set to true.

Returns:

String

getPrevVerUninstallAbortMsg

public java.lang.String getPrevVerUninstallAbortMsg()

Get message displayed when the uninstall of the previous version is aborted by the user.

Returns:

String

getPrevVerUninstallFailMsg

public java.lang.String getPrevVerUninstallFailMsg()

Get message displayed when the uninstall of the previous version fails.

Returns:

String

getUninstallAppRunCheckFn

public FunctionDefinition getUninstallAppRunCheckFn()

Get user defined function to check if the application is running when the uninstaller starts. If the value is not specified the check is not performed.

Returns:

FunctionDefinition

getUninstallConfirmPrompt

public java.lang.String getUninstallConfirmPrompt()

Get the prompt displayed to the user when the uninstaller is invoked.

Returns:

String

getUninstallSuccessMsg

public java.lang.String getUninstallSuccessMsg()

Get message displayed after successfully uninstalling the application.

Returns:

String

isUninstallPrevVer

public boolean isUninstallPrevVer()

Get if set to true, the installer will try to identify and uninstall any previous version of the application.

Returns:

boolean

isUseMutexForInstaller

public boolean isUseMutexForInstaller()

Get indicates if a mutex is to be used to ensure a single instance of the installer.

Returns:

boolean

setInstallAppRunCheckFn

public void setInstallAppRunCheckFn(FunctionDefinition installAppRunCheckFn)

Set user defined function to check if the application is running when the installer starts. If the value is not specified the check is not performed.

Parameters:

installAppRunCheckFn -

setMultiInstallerInstanceMessage

public void setMultiInstallerInstanceMessage(java.lang.String multiInstallerInstanceMessage)

Set the message to display when more than one instance of the installer is running.

Parameters:

multiInstallerInstanceMessage -

setPrevVerPresentPrompt

public void setPrevVerPresentPrompt(java.lang.String prevVerPresentPrompt)

Set the prompt to the user when a previous version of the application is found. This values is used only when uninstallPreviousVersion is set to true.

Parameters:

prevVerPresentPrompt -

setPrevVerUninstallAbortMsg

public void setPrevVerUninstallAbortMsg(java.lang.String prevVerUninstallAbortMsg)

Set message displayed when the uninstall of the previous version is aborted by the user.

Parameters:

prevVerUninstallAbortMsg -

setPrevVerUninstallFailMsg

public void setPrevVerUninstallFailMsg(java.lang.String prevVerUninstallFailMsg)

Set message displayed when the uninstall of the previous version fails.

Parameters:

prevVerUninstallFailMsg -

setUninstallAppRunCheckFn

public void setUninstallAppRunCheckFn(FunctionDefinition uninstallAppRunCheckFn)

Set user defined function to check if the application is running when the uninstaller starts. If the value is not specified the check is not performed.

Parameters:

uninstallAppRunCheckFn -

setUninstallConfirmPrompt

public void setUninstallConfirmPrompt(java.lang.String uninstallConfirmPrompt)

Set the prompt displayed to the user when the uninstaller is invoked.

Parameters:

uninstallConfirmPrompt -

setUninstallPrevVer

public void setUninstallPrevVer(boolean uninstallPrevVer)

Set if set to true, the installer will try to identify and uninstall any previous version of the application.

Parameters:

uninstallPrevVer -

setUninstallSuccessMsg

public void setUninstallSuccessMsg(java.lang.String uninstallSuccessMsg)

Set message displayed after successfully uninstalling the application.

Parameters:

uninstallSuccessMsg -

setUseMutexForInstaller

public void setUseMutexForInstaller(boolean useMutexForInstaller)

Set indicates if a mutex is to be used to ensure a single instance of the installer.

Parameters:

useMutexForInstaller -