|
|
Package com.dassault_systemes.pprnblcabase.controller |
Class LCABaseController
|
Class Hierarchy |
java.lang.Object | +-com.dassault_systemes.pprnblcabase.controller.LCABaseController
Class Location |
Class Description |
public class LCABaseController
Provides generic controller services
Field Summary |
String | _className |
CATDialog | _dialog |
CATSession | _session |
String | _document |
Hashtable | _parmTable |
Constructor Summary |
LCABaseController() |
Method Summary |
String | getWidgetID() |
void | init(CATDialog iDialog, CATNotification iNotification, Object iData) |
void | reinitOnDocChg() |
void | parseDocument() |
Object | getParameter(String iName) |
void | setParameters(Hashtable iParms) |
Object | getParameter(String iName, String iDefault) |
void | addParameter(String iName, Object iValue, StringBuffer iDoc) |
String | getStringValue(String iKey, String iDfltValue) |
String | getStringValue(String iFile, String iKey, String iDfltValue) |
void | setEnvValue(String iKey, String iValue) |
String | getEnvValue(String iKey, String iDfltValue) |
ENOVILogonToken | getLogonToken() |
void | stackReplace(String iCommand) |
void | stack(String iCommand) |
void | stack(String iCommand, String iDocument) |
CATDialog | stackView(String iCommand, String iDocument) |
void | unstack() |
boolean | ensureLogon() |
String | getObjectUUID() |
ENOVIDataObject | getDataObject(ENOVTypeMask iMask) |
ENOVIDataObject | getDataObject(String iUUID) |
ENOVIDataObject | getDataObject(String iUUID, ENOVTypeMask iMask) |
void | onCancel(CATDialog iDialog, CATNotification iNotification, Object iData) |
void | onCreate(CATDialog iDialog, CATNotification iNotification, Object iData) |
void | onDocumentChanged(CATDialog iDialog, CATNotification iNotification, Object iData) |
void | showStatusMessage(String iMsgKey, boolean iOk) |
void | showStatusMessage(String iMsgFile, String iMsgKey, boolean iOk) |
void | showStatusMessage(Message iStatusMsg) |
void | pushErrorMessage(String iMsgKey) |
void | pushMessage(String iMsgKey, int iSeverity) |
void | processMessageForCATMessageArea(String statusMsgText, CATSession session, boolean ok) |
Field Detail |
String _className
CATDialog _dialog
CATSession _session
String _document
Hashtable _parmTablename value pairs parsed from _document
Constructor Detail |
LCABaseController()Constructor for ControllerBase.
Method Detail |
String getWidgetID()
void init(CATDialog iDialog, CATNotification iNotification, Object iData)Initializes the basic constructor values.
void reinitOnDocChg()ReInitializes the list of parameters passed to this dialog as the document value.
void parseDocument()
Object getParameter(String iName)Returns a parameter value parsed from the input document value.
void setParameters(Hashtable iParms)
Object getParameter(String iName, String iDefault)Returns a parameter value parsed from the input document value.
void addParameter(String iName, Object iValue, StringBuffer iDoc)Helper routine to append a name/value pair to a document note: this method is not related to the "getParameter" in that it does not put a value into this objects parm table.
String getStringValue(String iKey, String iDfltValue)Returns the translated string or the key if no translation is found
iKey
iDfltValue
String getStringValue(String iFile, String iKey, String iDfltValue)Returns the translated string or the key if no translation is found
iFile
iKey
iDfltValue
void setEnvValue(String iKey, String iValue)
String getEnvValue(String iKey, String iDfltValue)
ENOVILogonToken getLogonToken()
void stackReplace(String iCommand)Calls another dialog, passing along all of the document parameters passed to this dialog.
void stack(String iCommand)Calls another dialog, passing along all of the document parameters passed to this dialog.
void stack(String iCommand, String iDocument)Calls another dialog, passing the input document parameters.
CATDialog stackView(String iCommand, String iDocument)Calls another dialog, passing the input document parameters.
void unstack()Removes this dialog from the stack. The previous dialog is made current.
boolean ensureLogon()This method will perfrom an automatic redirect to the logon page of the logon token is null. NOTE: Do not call this method during the "onCreate" event, since calling unstack during a dialog creation should not happen. Instead use this method during the "onDocumentChanged" event, which seem to always be called directly after the "onCreate" event. Returns true if logon token found, otherwise the logon xmldlg is stacked and false is returned. The current XMLDlg name and document will be passed to the logon for redirection following authentication.
String getObjectUUID()Function to encapsulate accessing the UUID of the focal object. This function is useful for dialog focusing on a single object.
ENOVIDataObject getDataObject(ENOVTypeMask iMask)Returns the data object for the given uuid
ENOVIDataObject getDataObject(String iUUID)
ENOVIDataObject getDataObject(String iUUID, ENOVTypeMask iMask)
void onCancel(CATDialog iDialog, CATNotification iNotification, Object iData)
void onCreate(CATDialog iDialog, CATNotification iNotification, Object iData)onCreate event handler which calls "init".
void onDocumentChanged(CATDialog iDialog, CATNotification iNotification, Object iData)onDocumentChanged event handler which calls init or reintOnDocChg as appropriate.
void showStatusMessage(String iMsgKey, boolean iOk)Displays the given status message.
void showStatusMessage(String iMsgFile, String iMsgKey, boolean iOk)Displays the given status message with the current message stack for details.
void showStatusMessage(Message iStatusMsg)Displays the given status message with the current message stack for details.
void pushErrorMessage(String iMsgKey)
void pushMessage(String iMsgKey, int iSeverity)
void processMessageForCATMessageArea(String statusMsgText, CATSession session, boolean ok)