|
|
|||||
| 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 |
| protected String | _className
|
| protected CATDialog | _dialog
|
| protected String | _document
|
| protected Hashtable | _parmTable
name value pairs parsed from _document |
| protected CATSession | _session
|
| Constructor Summary |
| LCABaseController()
Constructor for ControllerBase. |
| Method Summary |
| protected 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. |
| protected boolean | ensureLogon()
This method will perfrom an automatic redirect to the logon page of the logon token is null. |
| protected ENOVIDataObject | getDataObject(ENOVTypeMask iMask)
Returns the data object for the given uuid |
| protected ENOVIDataObject | getDataObject(String iUUID)
|
| protected ENOVIDataObject | getDataObject(String iUUID, ENOVTypeMask iMask)
|
| protected String | getEnvValue(String iKey, String iDfltValue)
|
| protected ENOVILogonToken | getLogonToken()
|
| protected String | getObjectUUID()
Function to encapsulate accessing the UUID of the focal object. |
| protected Object | getParameter(String iName)
Returns a parameter value parsed from the input document value. |
| protected Object | getParameter(String iName, String iDefault)
Returns a parameter value parsed from the input document value. |
| protected String | getStringValue(String iKey, String iDfltValue)
Returns the translated string or the key if no translation is found |
| protected String | getStringValue(String iFile, String iKey, String iDfltValue)
Returns the translated string or the key if no translation is found |
| public String | getWidgetID()
|
| protected void | init(CATDialog iDialog, CATNotification iNotification, Object iData)
Initializes the basic constructor values. |
| public void | onCancel(CATDialog iDialog, CATNotification iNotification, Object iData)
|
| public void | onCreate(CATDialog iDialog, CATNotification iNotification, Object iData)
onCreate event handler which calls "init". |
| public void | onDocumentChanged(CATDialog iDialog, CATNotification iNotification, Object iData)
onDocumentChanged event handler which calls init or reintOnDocChg as appropriate. |
| protected void | parseDocument()
|
| protected void | processMessageForCATMessageArea(String statusMsgText, CATSession session, boolean ok)
|
| protected void | pushErrorMessage(String iMsgKey)
|
| protected void | pushMessage(String iMsgKey, int iSeverity)
|
| protected void | reinitOnDocChg()
ReInitializes the list of parameters passed to this dialog as the document value. |
| protected void | setEnvValue(String iKey, String iValue)
|
| public void | setParameters(Hashtable iParms)
|
| protected void | showStatusMessage(Message iStatusMsg)
Displays the given status message with the current message stack for details. |
| protected void | showStatusMessage(String iMsgKey, boolean iOk)
Displays the given status message. |
| protected void | showStatusMessage(String iMsgFile, String iMsgKey, boolean iOk)
Displays the given status message with the current message stack for details. |
| protected void | stack(String iCommand)
Calls another dialog, passing along all of the document parameters passed to this dialog. |
| protected void | stack(String iCommand, String iDocument)
Calls another dialog, passing the input document parameters. |
| protected void | stackReplace(String iCommand)
Calls another dialog, passing along all of the document parameters passed to this dialog. |
| protected CATDialog | stackView(String iCommand, String iDocument)
Calls another dialog, passing the input document parameters. |
| protected void | unstack()
Removes this dialog from the stack. |
| Field Detail |
protected String _className
protected CATDialog _dialog
protected String _document
protected Hashtable _parmTable
name value pairs parsed from _document
protected CATSession _session
| Constructor Detail |
LCABaseController()
Constructor for ControllerBase.
| Method Detail |
protected 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.
protected 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.
protected ENOVIDataObject getDataObject(ENOVTypeMask iMask)
Returns the data object for the given uuid
protected ENOVIDataObject getDataObject(String iUUID)
protected ENOVIDataObject getDataObject(String iUUID, ENOVTypeMask iMask)
protected String getEnvValue(String iKey, String iDfltValue)
protected ENOVILogonToken getLogonToken()
protected String getObjectUUID()
Function to encapsulate accessing the UUID of the focal object.
This function is useful for dialog focusing on a single object.
protected Object getParameter(String iName)
Returns a parameter value parsed from the input document value.
protected Object getParameter(String iName, String iDefault)
Returns a parameter value parsed from the input document value.
protected String getStringValue(String iKey, String iDfltValue)
Returns the translated string or the key if no translation is found
iKeyiDfltValue
protected String getStringValue(String iFile, String iKey, String iDfltValue)
Returns the translated string or the key if no translation is found
iFileiKeyiDfltValue
public String getWidgetID()
protected void init(CATDialog iDialog, CATNotification iNotification, Object iData)
Initializes the basic constructor values.
public void onCancel(CATDialog iDialog, CATNotification iNotification, Object iData)
public void onCreate(CATDialog iDialog, CATNotification iNotification, Object iData)
onCreate event handler which calls "init".
public void onDocumentChanged(CATDialog iDialog, CATNotification iNotification, Object iData)
onDocumentChanged event handler which calls init or reintOnDocChg as appropriate.
protected void parseDocument()
protected void processMessageForCATMessageArea(String statusMsgText, CATSession session, boolean ok)
protected void pushErrorMessage(String iMsgKey)
protected void pushMessage(String iMsgKey, int iSeverity)
protected void reinitOnDocChg()
ReInitializes the list of parameters passed to this dialog as the document value.
protected void setEnvValue(String iKey, String iValue)
public void setParameters(Hashtable iParms)
protected void showStatusMessage(Message iStatusMsg)
Displays the given status message with the current message stack for details.
protected void showStatusMessage(String iMsgKey, boolean iOk)
Displays the given status message.
protected void showStatusMessage(String iMsgFile, String iMsgKey, boolean iOk)
Displays the given status message with the current message stack for details.
protected void stack(String iCommand)
Calls another dialog, passing along all of the document parameters passed to this dialog.
protected void stack(String iCommand, String iDocument)
Calls another dialog, passing the input document parameters.
protected void stackReplace(String iCommand)
Calls another dialog, passing along all of the document parameters passed to this dialog.
protected CATDialog stackView(String iCommand, String iDocument)
Calls another dialog, passing the input document parameters.
protected void unstack()
Removes this dialog from the stack. The previous dialog is made current.