com.altair.hwm.interfaces
Class HWMUserExitAdapter

java.lang.Object
  com.altair.hwm.interfaces.HWMUserExitAdapter

All Implemented Interfaces:

IHWMUserExit

public class HWMUserExitAdapter
extends java.lang.Object
implements IHWMUserExit

Title: HWMUserExitAdapter

Description: This is the adapter class for IHWUserExit. Provides methods that the "exit func hookup" class will override to modify EPIC's standard Project New, Project Open, Project Save and Project Close methods.

Company: Altair Engineering, Inc.

Field Summary

Fields inherited from interface com.altair.hwm.interfaces.IHWMUserExit

ABORT, CONTINUE, CONTINUE_WO_FILEBROWSER, ONLY_INSTANTIATE

Constructor Summary

HWMUserExitAdapter()

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

Methods inherited from class java.lang.Object

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

Constructor Detail

HWMUserExitAdapter

public HWMUserExitAdapter()

Method Detail

OnProjectNewPre

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

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

Specified by:

OnProjectNewPre in interface IHWMUserExit

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

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

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

Specified by:

OnProjectNewPost in interface IHWMUserExit

Parameters:

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

Returns:

int Must be CONTINUE

Throws:

java.lang.Exception

OnProjectOpenPre

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

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

Specified by:

OnProjectOpenPre in interface IHWMUserExit

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

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

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

Specified by:

OnProjectOpenPost in interface IHWMUserExit

Parameters:

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

Returns:

int Must be CONTINUE

Throws:

java.lang.Exception

OnProjectSavePre

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

Method that acts as an exit function for Project Save Pre

Specified by:

OnProjectSavePre in interface IHWMUserExit

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

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

Method that acts as an exit function for Project Save Post

Specified by:

OnProjectSavePost in interface IHWMUserExit

Parameters:

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

Returns:

int Must be CONTINUE

Throws:

java.lang.Exception

OnProjectClose

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

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

Specified by:

OnProjectClose in interface IHWMUserExit

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