Package com.dassault_systemes.catjwebapplicationcomposer.catjwacruntime

   
Class CATJWACHelper

 
Class Hierarchy
java.lang.Object
  |
  +-com.dassault_systemes.catjwebapplicationcomposer.catjwacruntime.CATJWACHelper
Class Location

Framework : CATJWebApplicationComposer

Module : CATJWACRuntime

Class Description

public class CATJWACHelper

Class for all helpers definitions used through the WebApplicationBuilder interactive tool. All public static methods can be used as helpers in a WebApplication.

Field Summary
public static final int ACTION_CANCEL
public static final int ACTION_CONTINUE
public static final int ACTION_FINISH
public static final String DISPLAY_MESSAGE
public static final String SEND_NOTIF_HOOKUP
public static final String STACK_COMMAND
public static final String STACK_EAPP_COMMAND

Constructor Summary
CATJWACHelper()

Method Summary
public static String buildEAppCommandOutputWithPortalUIDArg(String iCommand, PortalUID iParam)
Helper to format output string to send a JDialog command as output of the WebApplication
public static String[] buildEAppCommandOutputWithPortalUIDTableArg(String iCommand, PortalUID[] iParam)
Helper to format output string[] to send a JDialog command as output of the WebApplication
public static String buildEAppCommandOutputWithStringArg(String iCommand, String iParam)
Helper to format output string to send a EApp command as output of the WebApplication
public static String[] buildEAppCommandOutputWithStringTableArg(String iCommand, String[] iParam)
Helper to format output string[] to send a JDialog command as output of the WebApplication
public static String buildHookupNotifOutput(String iNotifClassName, String iNotifObject)
Helper to format output string to send an event to the hookup as output of the WebApplication
public static String buildJDialogCommandOutputWithPortalUIDArg(String iCommand, PortalUID iParam)
Helper to format output string to send a JDialog command as output of the WebApplication
public static String[] buildJDialogCommandOutputWithPortalUIDTableArg(String iCommand, PortalUID[] iParam)
Helper to format output string[] to send a JDialog command as output of the WebApplication
public static String buildJDialogCommandOutputWithStringArg(String iCommand, String iParam)
Helper to format output string to send a JDialog command as output of the WebApplication
public static String[] buildJDialogCommandOutputWithStringTableArg(String iCommand, String[] iParam)
Helper to format output string[] to send a JDialog command as output of the WebApplication
public static String buildMessageOutput(String iTitle, String iMessageText, int isev)
Helper to format output string to send a message as output of the WebApplication
public static String convertPortalUIDtoString(PortalUID portalUID)
Helper to convert a PortalUID to a String
public static String[] convertPortalUIDtoStringForTable(PortalUID[] portalUID)
Helper to convert a PortalUID table to a String table
public static PortalUID convertStringToPortalUID(String portalUIDAsString)
Helper to convert a PortalUID string format to a PortalUID object
public static PortalUID[] convertStringToPortalUIDForTable(String[] portalUIDAsString)
Helper to convert a table of string PortalUID table to a PortalUID table object
public static CATKeyTableModel createKeyTableModelSimpleString(String[] input, String title)
Helper to retrieve a predefined KeyTableModel to fill a single column CATTable with a list of string
public static void displayError(CATDialog iDialog, String iTitle, String iMessageText, int iSeverity)
Helper to display an error during Webapplication execution
public static String getArgByName(String[] inputArguments, String argName)
Helper to get the value of an argument identified by its name.
public static void gotoPage(String iPageName)
Helper for jump to a specific page of the WebApplication
public static boolean sendAddDocsIn3DViewerNotif(CATDialog iDialog, PortalUID[] iUids)
public static boolean sendOpenDocIn2DViewerNotif(CATDialog iDialog, PortalUID iUid)
public static boolean sendOpenDocsIn3DViewerNotif(CATDialog iDialog, PortalUID[] iUids)
public static void startProcess(String iProcessName)
Helper to start a subprocess during the WebApplication execution


Field Detail

ACTION_CANCEL

    public static final int ACTION_CANCEL


ACTION_CONTINUE

    public static final int ACTION_CONTINUE


ACTION_FINISH

    public static final int ACTION_FINISH


DISPLAY_MESSAGE

    public static final String DISPLAY_MESSAGE


SEND_NOTIF_HOOKUP

    public static final String SEND_NOTIF_HOOKUP


STACK_COMMAND

    public static final String STACK_COMMAND


STACK_EAPP_COMMAND

    public static final String STACK_EAPP_COMMAND


Constructor Detail

CATJWACHelper

    CATJWACHelper()


Method Detail

buildEAppCommandOutputWithPortalUIDArg

    public static String buildEAppCommandOutputWithPortalUIDArg(String iCommand, PortalUID iParam)

Helper to format output string to send a JDialog command as output of the WebApplication

Parameters:
iCommand
command name to be send
iParam
parameters of the command
Return:
formatted output String

buildEAppCommandOutputWithPortalUIDTableArg

    public static String[] buildEAppCommandOutputWithPortalUIDTableArg(String iCommand, PortalUID[] iParam)

Helper to format output string[] to send a JDialog command as output of the WebApplication

Parameters:
iCommand
command name to be send
iParam
parameters of the command
Return:
formatted output String[]

buildEAppCommandOutputWithStringArg

    public static String buildEAppCommandOutputWithStringArg(String iCommand, String iParam)

Helper to format output string to send a EApp command as output of the WebApplication

Parameters:
iCommand
command name to be send
iParam
parameters of the command
Return:
formatted output String

buildEAppCommandOutputWithStringTableArg

    public static String[] buildEAppCommandOutputWithStringTableArg(String iCommand, String[] iParam)

Helper to format output string[] to send a JDialog command as output of the WebApplication

Parameters:
iCommand
command name to be send
iParam
parameters of the command
Return:
formatted output String[]

buildHookupNotifOutput

    public static String buildHookupNotifOutput(String iNotifClassName, String iNotifObject)

Helper to format output string to send an event to the hookup as output of the WebApplication

Parameters:
iNotifClassName
Classname of the Notif to be send
iNotifObject
Object associated to the notif
Return:
formatted output String

buildJDialogCommandOutputWithPortalUIDArg

    public static String buildJDialogCommandOutputWithPortalUIDArg(String iCommand, PortalUID iParam)

Helper to format output string to send a JDialog command as output of the WebApplication

Parameters:
iCommand
command name to be send
iParam
parameters of the command
Return:
formatted output String

buildJDialogCommandOutputWithPortalUIDTableArg

    public static String[] buildJDialogCommandOutputWithPortalUIDTableArg(String iCommand, PortalUID[] iParam)

Helper to format output string[] to send a JDialog command as output of the WebApplication

Parameters:
iCommand
command name to be send
iParam
parameters of the command
Return:
formatted output String[]

buildJDialogCommandOutputWithStringArg

    public static String buildJDialogCommandOutputWithStringArg(String iCommand, String iParam)

Helper to format output string to send a JDialog command as output of the WebApplication

Parameters:
iCommand
command name to be send
iParam
parameters of the command
Return:
formatted output String

buildJDialogCommandOutputWithStringTableArg

    public static String[] buildJDialogCommandOutputWithStringTableArg(String iCommand, String[] iParam)

Helper to format output string[] to send a JDialog command as output of the WebApplication

Parameters:
iCommand
command name to be send
iParam
parameters of the command
Return:
formatted output String[]

buildMessageOutput

    public static String buildMessageOutput(String iTitle, String iMessageText, int isev)

Helper to format output string to send a message as output of the WebApplication

Parameters:
iTitle
Title of the message
iMessageText
Text of the message
isev
Severity of the message
Return:
Formatted output String

convertPortalUIDtoString

    public static String convertPortalUIDtoString(PortalUID portalUID)

Helper to convert a PortalUID to a String

Parameters:
portalUID
Return:

convertPortalUIDtoStringForTable

    public static String[] convertPortalUIDtoStringForTable(PortalUID[] portalUID)

Helper to convert a PortalUID table to a String table

Parameters:
portalUID
Return:

convertStringToPortalUID

    public static PortalUID convertStringToPortalUID(String portalUIDAsString)

Helper to convert a PortalUID string format to a PortalUID object

Parameters:
portalUIDAsString
Return:

convertStringToPortalUIDForTable

    public static PortalUID[] convertStringToPortalUIDForTable(String[] portalUIDAsString)

Helper to convert a table of string PortalUID table to a PortalUID table object

Parameters:
portalUIDAsString
Return:

createKeyTableModelSimpleString

    public static CATKeyTableModel createKeyTableModelSimpleString(String[] input, String title)

Helper to retrieve a predefined KeyTableModel to fill a single column CATTable with a list of string

Parameters:
input
List of strings to fill the CATTable
title
Title for the single column of the CATTable
Return:
A predefined KeyTableModel for a single column CATTable

displayError

    public static void displayError(CATDialog iDialog, String iTitle, String iMessageText, int iSeverity)

Helper to display an error during Webapplication execution

Parameters:
iDialog
Widget associated to the error
iTitle
Title for the error
iMessageText
Message text for the error
iSeverity
Severity for the error

getArgByName

    public static String getArgByName(String[] inputArguments, String argName)

Helper to get the value of an argument identified by its name.

Parameters:
inputArguments
table for input parameters(format for each inputArgument: argName=Value)
argName
Name of the requested argument
Return:
the value of the requested argument

gotoPage

    public static void gotoPage(String iPageName)

Helper for jump to a specific page of the WebApplication

Parameters:
iPageName
Name of the page to jump to

sendAddDocsIn3DViewerNotif

    public static boolean sendAddDocsIn3DViewerNotif(CATDialog iDialog, PortalUID[] iUids)


sendOpenDocIn2DViewerNotif

    public static boolean sendOpenDocIn2DViewerNotif(CATDialog iDialog, PortalUID iUid)


sendOpenDocsIn3DViewerNotif

    public static boolean sendOpenDocsIn3DViewerNotif(CATDialog iDialog, PortalUID[] iUids)


startProcess

    public static void startProcess(String iProcessName)

Helper to start a subprocess during the WebApplication execution

Parameters:
iProcessName
Name of the subprocess to start


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