Package com.dassault_systemes.pprnblcabase.command

   
Class LCANavCommand

 
Class Hierarchy
java.lang.Object
  |
  +-com.dassault_systemes.pprnblcabase.command.LCABaseCommand
        |
        +-com.dassault_systemes.pprnblcabase.command.LCANavCommand
Class Location

Framework : PPRJNavigatorBase

Module : PPRNBLcaBase

Class Description

public class LCANavCommand

Field Summary

Constructor Summary
LCANavCommand()

Method Summary
void execute(CATSession iSession)
void execute(CATDialog iDialog, Hashtable iParms)
String getCommandType()
Object getParameter(String iName)
ENOVILogonToken getLogonToken(CATSession iSession)
ENOVIDataObject[] getObjects(CATSession iSession)
PortalUID[] getPortalUIDs(CATSession iSession)
String[] getUUIDs(CATSession iSession)
ENOVIDataObject getSingleObject(CATSession iSession)
String getSingleObjectUUID(CATSession iSession)
Object removeParameter(String iName)
void showStatusMessage(CATSession iSession, boolean iCmdOk)
void showStatusMessage(CATSession iSession, String iMsgFile, String iMsgKey, boolean iOk)
void showStatusMessage(CATSession iSession, Message iStatusMsg)
CATDialog getActiveDialog(CATSession iSession)
String getCommandStatusTitle(CATSession iSession, boolean iCmdOk)
String getCommandStatusMessage(CATSession iSession, boolean iCmdOk)
void stackDialog(CATSession iSession, String iCommand, String iDocument, boolean iNewWindow)
void stackObjectDialog(CATSession iSession, String iCommand, String iUUID, String iAddlDocParms, boolean iNewWindow)
void stackPPRObjectDialog(CATSession iSession, String iCommand, String iAddlDocParms, boolean iNewWindow)
void stackMultiObjectDialog(CATSession iSession, String iCommand, boolean iNewWindow)
void stackMultiObjectDialog(CATSession iSession, String iCommand, String iAddlDocParms, boolean iNewWindow)
void stackMultiPPRObjectDialog(CATSession iSession, String iCommand, String iAddlDocParms, boolean iNewWindow)
void activateMultiObjectDialog(CATSession iSession, String iCommand, String iAddlDocParms, boolean iNewWindow)
void activateDialog(CATSession iSession, String iCommand, String iDocument, boolean iNewWindow)
boolean stackMultiObjectOneDialog()
void stackSingleObjectDialog(CATSession iSession, String iCommand)
void stackSingleObjectDialog(CATSession iSession, String iCommand, String iAddlDocParms)
void stackSingleObjectDialog(CATSession iSession, String iCommand, boolean iNewWindow)
void stackSingleObjectDialog(CATSession iSession, String iCommand, String iAddlDocParms, boolean iNewWindow)
void stackEntityDialog(CATSession iSession, String iCommand, String iAddlDocParms, boolean iNewWindow)
Object storeParameter(String iName, Object iData)
void raiseObjectUpdatedNotification(CATSession iSession, ENOVIDataObject iObject)
String getParmCommandType(Hashtable iParms)
ENOVIDataObject[] getParmObjects(CATSession iSession, Hashtable iParms)
PortalUID[] getParmPortalUIDs(CATSession iSession, Hashtable iParms)
String[] getParmUUIDs(CATSession iSession, Hashtable iParms)
void replaceParmObjects(Hashtable iParms, ENOVIDataObject[] iObjects)
void replaceParmPortalUIDs(Hashtable iParms, PortalUID[] iPortalUIDs)
void replaceParmUUIDs(Hashtable iParms, String[] iUUIDs)


Field Detail

Constructor Detail

LCANavCommand

    LCANavCommand()


Method Detail

execute

    void execute(CATSession iSession)


execute

    void execute(CATDialog iDialog, Hashtable iParms)

Executes a command, allowing stacking the next dialog that is to be displayed.


getCommandType

    String getCommandType()

Returns the command object that executed this command implementation.


getParameter

    Object getParameter(String iName)


getLogonToken

    ENOVILogonToken getLogonToken(CATSession iSession)


getObjects

    ENOVIDataObject[] getObjects(CATSession iSession)

Returns the list of objects passed to the command.


getPortalUIDs

    PortalUID[] getPortalUIDs(CATSession iSession)

Returns the list of object portal uids passed to the command.


getUUIDs

    String[] getUUIDs(CATSession iSession)

Returns the list of object uuids passed to the command.


getSingleObject

    ENOVIDataObject getSingleObject(CATSession iSession)

Returns the object passed to the command.


getSingleObjectUUID

    String getSingleObjectUUID(CATSession iSession)

Retrieves the single UUID for the command to operate upon. If no objects exist for the command then a null value is returned. If more than one object exists for the command then a message is logged.


removeParameter

    Object removeParameter(String iName)

Removes a parameter passed to the command.


showStatusMessage

    void showStatusMessage(CATSession iSession, boolean iCmdOk)

Sets the command status message.
  • The current message stack is captured for details.
  • The status message is computed based on the given success/failure of the command. See the method "getCommandStatusMessage".


    showStatusMessage

        void showStatusMessage(CATSession iSession, String iMsgFile, String iMsgKey, boolean iOk)
    
    
    Displays the given status message.
  • The current message stack is captured for details. The status message is obtained from the give CATNls file name and message key.


    showStatusMessage

        void showStatusMessage(CATSession iSession, Message iStatusMsg)
    
    
    Displays the given status message.
  • The current message stack is captured for details.


    getActiveDialog

        CATDialog getActiveDialog(CATSession iSession)
    
    


    getCommandStatusTitle

        String getCommandStatusTitle(CATSession iSession, boolean iCmdOk)
    
    


    getCommandStatusMessage

        String getCommandStatusMessage(CATSession iSession, boolean iCmdOk)
    
    
    Computes the command status message based on the given command success/failure flag.
  • The status message is computed as follows
    1. The command message catalog (if it exists) will be searched for a status message.
      for success: Command..StatusSucceeded
      for failure: Command..StatusFailed
    2. If we do not have a command specific status message, we will create one by concatenating the command label with a generic success or failure message.


    stackDialog

        void stackDialog(CATSession iSession, String iCommand, String iDocument, boolean iNewWindow)
    
    
    Stacks a dialog upon return from the command execution.


    stackObjectDialog

        void stackObjectDialog(CATSession iSession, String iCommand, String iUUID, String iAddlDocParms, boolean iNewWindow)
    
    
    Pass the standard document parameters for a stack of a single object dialog call.


    stackPPRObjectDialog

        void stackPPRObjectDialog(CATSession iSession, String iCommand, String iAddlDocParms, boolean iNewWindow)
    
    
    Pass the standard document parameters for a stack of a single object dialog call.


    stackMultiObjectDialog

        void stackMultiObjectDialog(CATSession iSession, String iCommand, boolean iNewWindow)
    
    
    Stacks a dialog for a single object, passing the object UUID as the command document


    stackMultiObjectDialog

        void stackMultiObjectDialog(CATSession iSession, String iCommand, String iAddlDocParms, boolean iNewWindow)
    
    
    Stacks a dialog for multiple objects, passing the object UUIDs as the command document.


    stackMultiPPRObjectDialog

        void stackMultiPPRObjectDialog(CATSession iSession, String iCommand, String iAddlDocParms, boolean iNewWindow)
    
    
    Stacks a dialog for multiple objects, passing the object PortalUIDs as the command document.


    activateMultiObjectDialog

        void activateMultiObjectDialog(CATSession iSession, String iCommand, String iAddlDocParms, boolean iNewWindow)
    
    
    Activates a dialog for a single object as a persistent command, passing the object UUID as the command document. If additional document parameters are passed, the object UUID is passed as the first document parameter then the additional document parameters are included.

    Parameters:
    iSession
    iCommand
    iAddlDocParms
    iNewWindow

    activateDialog

        void activateDialog(CATSession iSession, String iCommand, String iDocument, boolean iNewWindow)
    
    
    Stacks a dialog upon return from the command execution.


    stackMultiObjectOneDialog

        boolean stackMultiObjectOneDialog()
    
    
    Indicates if a stackMultiObjectDialog should send all of the UUIDs to a single dialog. If this routine returns false, then a dialog will be stacked for each object uuid.


    stackSingleObjectDialog

        void stackSingleObjectDialog(CATSession iSession, String iCommand)
    
    
    Stacks a dialog for a single object, passing the object UUID as the command document


    stackSingleObjectDialog

        void stackSingleObjectDialog(CATSession iSession, String iCommand, String iAddlDocParms)
    
    
    Stacks a dialog for a single object, passing the object UUID and the provided additional parameters as the command document


    stackSingleObjectDialog

        void stackSingleObjectDialog(CATSession iSession, String iCommand, boolean iNewWindow)
    
    
    Stacks a dialog for a single object, passing the object UUID as the command document


    stackSingleObjectDialog

        void stackSingleObjectDialog(CATSession iSession, String iCommand, String iAddlDocParms, boolean iNewWindow)
    
    
    Stacks a dialog for a single object, passing the object UUID as the command document. If additional document parameters are passed, the object UUID is passed as the first document parameter then the additional document parameters are included.


    stackEntityDialog

        void stackEntityDialog(CATSession iSession, String iCommand, String iAddlDocParms, boolean iNewWindow)
    
    
    Stacks a dialog for a entity type, passing the command object


    storeParameter

        Object storeParameter(String iName, Object iData)
    
    


    raiseObjectUpdatedNotification

        void raiseObjectUpdatedNotification(CATSession iSession, ENOVIDataObject iObject)
    
    
    Raises an update notification for the given object


    getParmCommandType

        String getParmCommandType(Hashtable iParms)
    
    
    Access to the command type from the command parameters.


    getParmObjects

        ENOVIDataObject[] getParmObjects(CATSession iSession, Hashtable iParms)
    
    
    Access to the ENOVIDataObjects from the command parameters.


    getParmPortalUIDs

        PortalUID[] getParmPortalUIDs(CATSession iSession, Hashtable iParms)
    
    
    Returns the list of object portal uids from the command parameters.


    getParmUUIDs

        String[] getParmUUIDs(CATSession iSession, Hashtable iParms)
    
    
    Returns the list of object uuids from the command parameters.


    replaceParmObjects

        void replaceParmObjects(Hashtable iParms, ENOVIDataObject[] iObjects)
    
    
    Replaces the list of objects in the command parameters.


    replaceParmPortalUIDs

        void replaceParmPortalUIDs(Hashtable iParms, PortalUID[] iPortalUIDs)
    
    
    Replaces the list of objects in the command parameters.


    replaceParmUUIDs

        void replaceParmUUIDs(Hashtable iParms, String[] iUUIDs)
    
    
    Replaces the list of objects in the command parameters.



    Copyright © 2000, Dassault Systèmes. All rights reserved