com.altair.hwm.interfaces
Interface IHWMUserExit

All Known Implementing Classes:

HWMUserExitAdapter

public interface IHWMUserExit

Title: IHWMUserExit

Description: This is the interface that should be implemented by beans that need to override EPIC's standard Project New, Project Open, Project Save and Project Close methods.

Company: Altair Engineering, Inc.

Field Summary

static int	ABORT
static int	CONTINUE RETURN CODES
static int	CONTINUE_WO_FILEBROWSER
static int	ONLY_INSTANTIATE

Method Summary

int	OnProjectClose(IHWMFrameWork hwmFrameWork) Method that acts as an exit function for Project Close (Pre)
int	OnProjectNewPost(IHWMFrameWork hwmFrameWork) Method that acts as an user exit function for Project New Post
int	OnProjectNewPre(java.lang.String[] arrstrFileName) Method that acts as the user exit function for Project New Pre
int	OnProjectOpenPost(IHWMFrameWork hwmFrameWork) Method that acts as the user exit function for Project Open Post
int	OnProjectOpenPre(java.lang.String[] arrstrFileName) Method that acts as the user exit function for Project Open Pre
int	OnProjectSavePost(IHWMFrameWork hwmFrameWork) Method that acts as an exit function for Project Save Post
int	OnProjectSavePre(IHWMFrameWork hwmFrameWork) Method that acts as an exit function for Project Save Pre

Field Detail

CONTINUE

static final int CONTINUE

RETURN CODES

See Also:

Constant Field Values

CONTINUE_WO_FILEBROWSER

static final int CONTINUE_WO_FILEBROWSER

See Also:

Constant Field Values

ONLY_INSTANTIATE

static final int ONLY_INSTANTIATE

See Also:

Constant Field Values

ABORT

static final int ABORT

See Also:

Constant Field Values

Method Detail

OnProjectNewPre

int OnProjectNewPre(java.lang.String[] arrstrFileName)
                    throws java.lang.Exception

Method that acts as the user exit function for Project New Pre

Parameters:

arrstrFileName - (Out; memory already allocated) The procedure should fill in arrstrFileName[0] to be the name of the file to create/set as the model instance name

Returns:

int (enum) One of the following ABORT -- EPIC will abort the process of File->New CONTINUE - EPIC will do everything it does (including throwing a file browser for prj file selection) CONTINUE_WO_FILEBROWSER - EPIC will do everything it does (except throwing a file browser for prj file selection). arrstrFileName[0] will be the filename to create.

Throws:

java.lang.Exception

OnProjectNewPost

int OnProjectNewPost(IHWMFrameWork hwmFrameWork)
                     throws java.lang.Exception

Method that acts as an user exit function for Project New Post

Parameters:

hwmFrameWork - The interface with which this object can communicate with the HWM application.

Returns:

int Must be CONTINUE

Throws:

java.lang.Exception

OnProjectOpenPre

int OnProjectOpenPre(java.lang.String[] arrstrFileName)
                     throws java.lang.Exception

Method that acts as the user exit function for Project Open Pre

Parameters:

arrstrFileName - (Out; memory already allocated) The procedure should fill in arrstrFileName[0] to be the name of the file to create/set as the model instance name

Returns:

int (enum) One of the following ABORT -- EPIC will abort the process of File->Open CONTINUE - EPIC will do everything it does (including throwing a file browser for prj file selection) CONTINUE_WO_FILEBROWSER - EPIC will do everything it does (except throwing a file browser for prj file selection). arrstrFileName[0] will be the filename to open. ONLY_INSTANTIATE - EPIC will instantiate the beans and the workflow, but will not read any project file. arrstrFileName[0] will be the name of the model instance.

Throws:

java.lang.Exception

OnProjectOpenPost

int OnProjectOpenPost(IHWMFrameWork hwmFrameWork)
                      throws java.lang.Exception

Method that acts as the user exit function for Project Open Post

Parameters:

hwmFrameWork - The interface with which this object can communicate with the HWM application.

Returns:

int Must be CONTINUE

Throws:

java.lang.Exception

OnProjectSavePre

int OnProjectSavePre(IHWMFrameWork hwmFrameWork)
                     throws java.lang.Exception

Method that acts as an exit function for Project Save Pre

Parameters:

hwmFrameWork - The interface with which this object can communicate with the HWM application.

Returns:

int CONTINUE => EPIC will continue with its File->Save operation ABORT (or Exception) => EPIC will not perform its File->Save

Throws:

java.lang.Exception

OnProjectSavePost

int OnProjectSavePost(IHWMFrameWork hwmFrameWork)
                      throws java.lang.Exception

Method that acts as an exit function for Project Save Post

Parameters:

hwmFrameWork - The interface with which this object can communicate with the HWM application.

Returns:

int Must be CONTINUE

Throws:

java.lang.Exception

OnProjectClose

int OnProjectClose(IHWMFrameWork hwmFrameWork)
                   throws java.lang.Exception

Method that acts as an exit function for Project Close (Pre)

Parameters:

hwmFrameWork - The interface with which this object can communicate with the HWM application.

Returns:

int CONTINUE => EPIC will continue with its File->Close operation ABORT (or Exception) => EPIC will abort the File->Close operation

Throws:

java.lang.Exception