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