com.tivoli.twg.engine
Class CreatePopupEventCmd

java.lang.Object
  extended bycom.tivoli.twg.libs.Command
      extended bycom.tivoli.twg.engine.CreatePopupEventCmd

public class CreatePopupEventCmd
extends Command

Command class for creating popup events


Field Summary
 
Fields inherited from class com.tivoli.twg.libs.Command
CMD_SENDER_FLAG, CMDRET_CREATE_CMDPKT_FAILED, CMDRET_ENCRYPT_FAIL, CMDRET_ENQUEUE_LOCAL_FAILED, CMDRET_INVALID_DEST_ADDRESS, CMDRET_NO_LOCAL_SVCNODE_IMPL, CMDRET_SECURE_FAIL, CMDRET_SEND_BUFFER_FAILED, CMDRET_SEND_FAILED, CMDRET_SEND_TIMEOUT, CMDRET_SERVICEFAILED, CMDRET_SESS_DISABLED_LCL, CMDRET_SESS_DISABLED_RMT, CMDRET_SESS_UNAVAIL_LCL, CMDRET_SESS_UNAVAIL_RMT, CMDRET_SESS_WAIT_DONE, CMDRET_SESS_WAIT_EXPIRED, CMDRET_SESS_WAITING, COMMAND_TYPE_INPUT, COMMAND_TYPE_OUTPUT, DEFAULT_CMD_TIMEOUT, ENQUEUE_FAILED_COPYDATA, ENQUEUE_FAILED_NO_DESTPATH, ENQUEUE_FAILED_NO_PROCESS_HANDLE, ENQUEUE_FAILED_NO_SVC_NODE_HANDLE, ENQUEUE_FAILED_SECURITY, ENQUEUE_GENERAL_FAILURE, JNI_BUFFER_NULL, JNI_ENTRY_POINT_NOT_LOADED, JNI_HANDLE_NULL, JNI_INITIALIZE_FAILED, RMI_LOOKUP_ERROR, SESSION_NONE, SESSION_PREFERRED, SESSION_REQUIRED
 
Constructor Summary
CreatePopupEventCmd(java.lang.String title, java.lang.String text, java.lang.String nls, java.lang.Object[] parms, java.lang.String handler, DataValue[] popup_parms, StringValueSet targets, boolean immed_only, boolean persist)
          Constructor for popup event command
CreatePopupEventCmd(java.lang.String title, java.lang.String text, java.lang.String nls, java.lang.Object[] parms, java.lang.String handler, DataValue[] popup_parms, StringValueSet targets, boolean immed_only, boolean persist, boolean first_ack_dismiss, boolean suggest_marque)
          Constructor for popup event command
 
Method Summary
 long getEventObjectID()
          Get ID assigned to created popup event object
 
Methods inherited from class com.tivoli.twg.libs.Command
AddInputParm, AddInputParm, AddObjectAsInputParm, AddObjectAsOutputParm, AddOutputParm, AddOutputParm, addToDebugStrings, AllocateBuffer, AttachInputParm, AttachOutputParm, CmdId, CommandCode, commandCodeDebugString, CommandComplete, CompressObject, debugPrint, DecompressObject, DestinationAddress, DetachInputParm, DetachOutputParm, FreeBuffer, FreeInputsAfterSend, getCmdType, GetObjectFromInputParm, GetObjectFromOutputParm, getSenderServiceNode, hexDump, InputParm, InputParm, InputParmLength, IsFlatInputBuffer, IsFlatOutputBuffer, IsPostponedReply, MakeFlatInputBuffer, MakeFlatOutputBuffer, NumInputParms, NumOutputParms, OutputParm, OutputParm, OutputParmLength, Postpo neReply, ResetIndex, ResetInput, ResetOutput, ReturnAddress, ReturnCode, ReturnCodeToString, RootDestinationAddress, RootReturnAddress, SessionHold, SessionMode, SessionRelease, SessionWaitTime, setCmdType, setCmdTypeInput, setCmdTypeOutput, SetCommandCode, setCommandCodeDebugString, setCommandCompleteListener, SetDestinationAddress, SetNewID, SetReturnAddress, SetReturnCode, setSenderServiceNode, SetSessionHold, SetSessionMode, SetSessionRelease, SetSessionWaitTime, SetTimeOut, TimeOut, toString, UseFlatInputBuffer, UseFlatOutputBuffer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CreatePopupEventCmd

public CreatePopupEventCmd(java.lang.String title,
                           java.lang.String text,
                           java.lang.String nls,
                           java.lang.Object[] parms,
                           java.lang.String handler,
                           DataValue[] popup_parms,
                           StringValueSet targets,
                           boolean immed_only,
                           boolean persist)
Constructor for popup event command

Parameters:
title - - title string, or title string ID (if nls provided)
text - - text string, or text string ID (if nls provided)
nls - - class name for ResourceBundle containing title and text strings, or null if none (title and text are then final values)
parms - - parameters for text/title format strings : limited to String, Long, Double, Date and TWGNLSString classes (uses toString() for others)
handler - - popup handler classname, or null if default handler
popup_parms - - parameters for popup handlers
targets - - target account names, or "*" if all accounts
immed_only - - true if only for immediate delivery, false if immediate or next logon (for inactive IDs)
persist - - true if persistent, false if popup lost on server restart (if immed_only is true, this parameter is ignored)

CreatePopupEventCmd

public CreatePopupEventCmd(java.lang.String title,
                           java.lang.String text,
                           java.lang.String nls,
                           java.lang.Object[] parms,
                           java.lang.String handler,
                           DataValue[] popup_parms,
                           StringValueSet targets,
                           boolean immed_only,
                           boolean persist,
                           boolean first_ack_dismiss,
                           boolean suggest_marque)
Constructor for popup event command

Parameters:
title - - title string, or title string ID (if nls provided)
text - - text string, or text string ID (if nls provided)
nls - - class name for ResourceBundle containing title and text strings, or null if none (title and text are then final values)
parms - - parameters for text/title format strings : limited to String, Long, Double, Date and TWGNLSString classes (uses toString() for others)
handler - - popup handler classname, or null if default handler
popup_parms - - parameters for popup handlers
targets - - target account names, or "*" if all accounts
immed_only - - true if only for immediate delivery, false if immediate or next logon (for inactive IDs)
persist - - true if persistent, false if popup lost on server restart (if immed_only is true, this parameter is ignored)
first_ack_dismiss - - true if popup should be dismissed by first acknowledge, false if only dismissed after all targets acknowledge
suggest_marque - - suggest display of popup on marque (true), or using normal popup handlers (false)
Method Detail

getEventObjectID

public long getEventObjectID()
Get ID assigned to created popup event object

Returns:
object ID, or 0 if failed