|
|
|||||
| 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 |
| Class Description |
public class LCANavCommand
| Field Summary |
| Constructor Summary |
| LCANavCommand()
|
| Method Summary |
| public void | activateDialog(CATSession iSession, String iCommand, String iDocument, boolean iNewWindow)
Stacks a dialog upon return from the command execution. |
| public 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. |
| public void | execute(CATDialog iDialog, Hashtable iParms)
Executes a command, allowing stacking the next dialog that is to be displayed. |
| protected void | execute(CATSession iSession)
|
| public CATDialog | getActiveDialog(CATSession iSession)
|
| public String | getCommandStatusMessage(CATSession iSession, boolean iCmdOk)
Computes the command status message based on the given command success/failure flag. |
| public String | getCommandStatusTitle(CATSession iSession, boolean iCmdOk)
|
| public String | getCommandType()
Returns the command object that executed this command implementation. |
| protected ENOVILogonToken | getLogonToken(CATSession iSession)
|
| public ENOVIDataObject[] | getObjects(CATSession iSession)
Returns the list of objects passed to the command. |
| public Object | getParameter(String iName)
|
| public static String | getParmCommandType(Hashtable iParms)
Access to the command type from the command parameters. |
| public static ENOVIDataObject[] | getParmObjects(CATSession iSession, Hashtable iParms)
Access to the ENOVIDataObjects from the command parameters. |
| public static PortalUID[] | getParmPortalUIDs(CATSession iSession, Hashtable iParms)
Returns the list of object portal uids from the command parameters. |
| public static String[] | getParmUUIDs(CATSession iSession, Hashtable iParms)
Returns the list of object uuids from the command parameters. |
| public PortalUID[] | getPortalUIDs(CATSession iSession)
Returns the list of object portal uids passed to the command. |
| protected ENOVIDataObject | getSingleObject(CATSession iSession)
Returns the object passed to the command. |
| public String | getSingleObjectUUID(CATSession iSession)
Retrieves the single UUID for the command to operate upon. |
| public String[] | getUUIDs(CATSession iSession)
Returns the list of object uuids passed to the command. |
| public void | raiseObjectUpdatedNotification(CATSession iSession, ENOVIDataObject iObject)
Raises an update notification for the given object |
| public Object | removeParameter(String iName)
Removes a parameter passed to the command. |
| public static void | replaceParmObjects(Hashtable iParms, ENOVIDataObject[] iObjects)
Replaces the list of objects in the command parameters. |
| public static void | replaceParmPortalUIDs(Hashtable iParms, PortalUID[] iPortalUIDs)
Replaces the list of objects in the command parameters. |
| public static void | replaceParmUUIDs(Hashtable iParms, String[] iUUIDs)
Replaces the list of objects in the command parameters. |
| public void | showStatusMessage(CATSession iSession, boolean iCmdOk)
Sets the command status message. |
| public void | showStatusMessage(CATSession iSession, Message iStatusMsg)
Displays the given status message. |
| public void | showStatusMessage(CATSession iSession, String iMsgFile, String iMsgKey, boolean iOk)
Displays the given status message. |
| public void | stackDialog(CATSession iSession, String iCommand, String iDocument, boolean iNewWindow)
Stacks a dialog upon return from the command execution. |
| public void | stackEntityDialog(CATSession iSession, String iCommand, String iAddlDocParms, boolean iNewWindow)
Stacks a dialog for a entity type, passing the command object |
| public void | stackMultiObjectDialog(CATSession iSession, String iCommand, boolean iNewWindow)
Stacks a dialog for a single object, passing the object UUID as the command document |
| public void | stackMultiObjectDialog(CATSession iSession, String iCommand, String iAddlDocParms, boolean iNewWindow)
Stacks a dialog for multiple objects, passing the object UUIDs as the command document. |
| public boolean | stackMultiObjectOneDialog()
Indicates if a stackMultiObjectDialog should send all of the UUIDs to a single dialog. |
| public void | stackMultiPPRObjectDialog(CATSession iSession, String iCommand, String iAddlDocParms, boolean iNewWindow)
Stacks a dialog for multiple objects, passing the object PortalUIDs as the command document. |
| public 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. |
| public void | stackPPRObjectDialog(CATSession iSession, String iCommand, String iAddlDocParms, boolean iNewWindow)
Pass the standard document parameters for a stack of a single object dialog call. |
| public void | stackSingleObjectDialog(CATSession iSession, String iCommand)
Stacks a dialog for a single object, passing the object UUID as the command document |
| public void | stackSingleObjectDialog(CATSession iSession, String iCommand, boolean iNewWindow)
Stacks a dialog for a single object, passing the object UUID as the command document |
| public 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 |
| public 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. |
| public Object | storeParameter(String iName, Object iData)
|
| Field Detail |
| Constructor Detail |
LCANavCommand()
| Method Detail |
public void activateDialog(CATSession iSession, String iCommand, String iDocument, boolean iNewWindow)
Stacks a dialog upon return from the command execution.
public 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.
iSessioniCommandiAddlDocParmsiNewWindow
public void execute(CATDialog iDialog, Hashtable iParms)
Executes a command, allowing stacking the next dialog that is to be displayed.
protected void execute(CATSession iSession)
public CATDialog getActiveDialog(CATSession iSession)
public String getCommandStatusMessage(CATSession iSession, boolean iCmdOk)
Computes the command status message based on the given command success/failure flag.
public String getCommandStatusTitle(CATSession iSession, boolean iCmdOk)
public String getCommandType()
Returns the command object that executed this command implementation.
protected ENOVILogonToken getLogonToken(CATSession iSession)
public ENOVIDataObject[] getObjects(CATSession iSession)
Returns the list of objects passed to the command.
public Object getParameter(String iName)
public static String getParmCommandType(Hashtable iParms)
Access to the command type from the command parameters.
public static ENOVIDataObject[] getParmObjects(CATSession iSession, Hashtable iParms)
Access to the ENOVIDataObjects from the command parameters.
public static PortalUID[] getParmPortalUIDs(CATSession iSession, Hashtable iParms)
Returns the list of object portal uids from the command parameters.
public static String[] getParmUUIDs(CATSession iSession, Hashtable iParms)
Returns the list of object uuids from the command parameters.
public PortalUID[] getPortalUIDs(CATSession iSession)
Returns the list of object portal uids passed to the command.
protected ENOVIDataObject getSingleObject(CATSession iSession)
Returns the object passed to the command.
public 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.
public String[] getUUIDs(CATSession iSession)
Returns the list of object uuids passed to the command.
public void raiseObjectUpdatedNotification(CATSession iSession, ENOVIDataObject iObject)
Raises an update notification for the given object
public Object removeParameter(String iName)
Removes a parameter passed to the command.
public static void replaceParmObjects(Hashtable iParms, ENOVIDataObject[] iObjects)
Replaces the list of objects in the command parameters.
public static void replaceParmPortalUIDs(Hashtable iParms, PortalUID[] iPortalUIDs)
Replaces the list of objects in the command parameters.
public static void replaceParmUUIDs(Hashtable iParms, String[] iUUIDs)
Replaces the list of objects in the command parameters.
public void showStatusMessage(CATSession iSession, boolean iCmdOk)
Sets the command status message.
public void showStatusMessage(CATSession iSession, Message iStatusMsg)
Displays the given status message.
public void showStatusMessage(CATSession iSession, String iMsgFile, String iMsgKey, boolean iOk)
Displays the given status message.
public void stackDialog(CATSession iSession, String iCommand, String iDocument, boolean iNewWindow)
Stacks a dialog upon return from the command execution.
public void stackEntityDialog(CATSession iSession, String iCommand, String iAddlDocParms, boolean iNewWindow)
Stacks a dialog for a entity type, passing the command object
public void stackMultiObjectDialog(CATSession iSession, String iCommand, boolean iNewWindow)
Stacks a dialog for a single object, passing the object UUID as the command document
public void stackMultiObjectDialog(CATSession iSession, String iCommand, String iAddlDocParms, boolean iNewWindow)
Stacks a dialog for multiple objects, passing the object UUIDs as the command document.
public 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.
public void stackMultiPPRObjectDialog(CATSession iSession, String iCommand, String iAddlDocParms, boolean iNewWindow)
Stacks a dialog for multiple objects, passing the object PortalUIDs as the command document.
public 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.
public void stackPPRObjectDialog(CATSession iSession, String iCommand, String iAddlDocParms, boolean iNewWindow)
Pass the standard document parameters for a stack of a single object dialog call.
public void stackSingleObjectDialog(CATSession iSession, String iCommand)
Stacks a dialog for a single object, passing the object UUID as the command document
public void stackSingleObjectDialog(CATSession iSession, String iCommand, boolean iNewWindow)
Stacks a dialog for a single object, passing the object UUID as the command document
public 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
public 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.
public Object storeParameter(String iName, Object iData)