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
String DISPLAY_MESSAGE
String STACK_COMMAND
String STACK_EAPP_COMMAND
String SEND_NOTIF_HOOKUP
int ACTION_CONTINUE
int ACTION_FINISH
int ACTION_CANCEL

Constructor Summary
CATJWACHelper()

Method Summary
void gotoPage(String iPageName)
void startProcess(String iProcessName)
String getArgByName(String[] inputArguments, String argName)
String buildMessageOutput(String iTitle, String iMessageText, int isev)
String buildJDialogCommandOutputWithStringArg(String iCommand, String iParam)
String[] buildJDialogCommandOutputWithStringTableArg(String iCommand, String[] iParam)
String buildJDialogCommandOutputWithPortalUIDArg(String iCommand, PortalUID iParam)
String[] buildJDialogCommandOutputWithPortalUIDTableArg(String iCommand, PortalUID[] iParam)
String buildEAppCommandOutputWithStringArg(String iCommand, String iParam)
String[] buildEAppCommandOutputWithStringTableArg(String iCommand, String[] iParam)
String buildEAppCommandOutputWithPortalUIDArg(String iCommand, PortalUID iParam)
String[] buildEAppCommandOutputWithPortalUIDTableArg(String iCommand, PortalUID[] iParam)
String buildHookupNotifOutput(String iNotifClassName, String iNotifObject)
void displayError(CATDialog iDialog, String iTitle, String iMessageText, int iSeverity)
CATKeyTableModel createKeyTableModelSimpleString(String[] input, String title)
String convertPortalUIDtoString(PortalUID portalUID)
String[] convertPortalUIDtoStringForTable(PortalUID[] portalUID)
PortalUID convertStringToPortalUID(String portalUIDAsString)
PortalUID[] convertStringToPortalUIDForTable(String[] portalUIDAsString)
boolean sendOpenDocsIn3DViewerNotif(CATDialog iDialog, PortalUID[] iUids)
boolean sendAddDocsIn3DViewerNotif(CATDialog iDialog, PortalUID[] iUids)
boolean sendOpenDocIn2DViewerNotif(CATDialog iDialog, PortalUID iUid)


Field Detail

DISPLAY_MESSAGE

    String DISPLAY_MESSAGE


STACK_COMMAND

    String STACK_COMMAND


STACK_EAPP_COMMAND

    String STACK_EAPP_COMMAND


SEND_NOTIF_HOOKUP

    String SEND_NOTIF_HOOKUP


ACTION_CONTINUE

    int ACTION_CONTINUE


ACTION_FINISH

    int ACTION_FINISH


ACTION_CANCEL

    int ACTION_CANCEL


Constructor Detail

CATJWACHelper

    CATJWACHelper()


Method Detail

gotoPage

    void gotoPage(String iPageName)

Helper for jump to a specific page of the WebApplication

Parameters:
iPageName
Name of the page to jump to

startProcess

    void startProcess(String iProcessName)

Helper to start a subprocess during the WebApplication execution

Parameters:
iProcessName
Name of the subprocess to start

getArgByName

    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
Returns:
the value of the requested argument

buildMessageOutput

    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
Returns:
Formatted output String

buildJDialogCommandOutputWithStringArg

    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
Returns:
formatted output String

buildJDialogCommandOutputWithStringTableArg

    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
Returns:
formatted output String[]

buildJDialogCommandOutputWithPortalUIDArg

    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
Returns:
formatted output String

buildJDialogCommandOutputWithPortalUIDTableArg

    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
Returns:
formatted output String[]

buildEAppCommandOutputWithStringArg

    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
Returns:
formatted output String

buildEAppCommandOutputWithStringTableArg

    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
Returns:
formatted output String[]

buildEAppCommandOutputWithPortalUIDArg

    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
Returns:
formatted output String

buildEAppCommandOutputWithPortalUIDTableArg

    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
Returns:
formatted output String[]

buildHookupNotifOutput

    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
Returns:
formatted output String

displayError

    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

createKeyTableModelSimpleString

    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
Returns:
A predefined KeyTableModel for a single column CATTable

convertPortalUIDtoString

    String convertPortalUIDtoString(PortalUID portalUID)

Helper to convert a PortalUID to a String

Parameters:
portalUID
Returns:

convertPortalUIDtoStringForTable

    String[] convertPortalUIDtoStringForTable(PortalUID[] portalUID)

Helper to convert a PortalUID table to a String table

Parameters:
portalUID
Returns:

convertStringToPortalUID

    PortalUID convertStringToPortalUID(String portalUIDAsString)

Helper to convert a PortalUID string format to a PortalUID object

Parameters:
portalUIDAsString
Returns:

convertStringToPortalUIDForTable

    PortalUID[] convertStringToPortalUIDForTable(String[] portalUIDAsString)

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

Parameters:
portalUIDAsString
Returns:

sendOpenDocsIn3DViewerNotif

    boolean sendOpenDocsIn3DViewerNotif(CATDialog iDialog, PortalUID[] iUids)


sendAddDocsIn3DViewerNotif

    boolean sendAddDocsIn3DViewerNotif(CATDialog iDialog, PortalUID[] iUids)


sendOpenDocIn2DViewerNotif

    boolean sendOpenDocIn2DViewerNotif(CATDialog iDialog, PortalUID iUid)



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