|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tivoli.twg.engine.TWGObject
com.tivoli.twg.engine.TWGPopupEvent
Console popup event record: contains description of a console popup event (either persistent or transient).
Constructor Summary | |
---|---|
TWGPopupEvent()
Default constructor |
|
TWGPopupEvent(java.lang.String handler,
java.lang.String nls_bndl,
java.lang.String titl,
java.lang.String txt,
java.lang.Object[] prms,
byte[] popup_prms,
StringValueSet accounts,
long timestmp)
Full constructor : initializes all parameters |
|
TWGPopupEvent(java.lang.String handler,
java.lang.String nls_bndl,
java.lang.String titl,
java.lang.String txt,
java.lang.Object[] prms,
byte[] popup_prms,
StringValueSet accounts,
long timestmp,
boolean one_ack_only,
boolean marque_display,
boolean is_persist,
boolean immed_only)
Full constructor : initializes all parameters |
Method Summary | |
---|---|
static void |
attachEventsToConsole(TWGActiveConsole con)
Attach all events for given console : called when a new active console is created |
void |
AttachObjectToConsole(TWGActiveConsole act_con)
Associate the object with the given TWGActiveConsole instance. |
void |
attachToActiveConsoles()
Attach to active consoles matching accounts : called when a new popup event is created or restored |
void |
Delete()
Delete method for relationship set |
void |
DetachObjectFromAllConsoles()
Disassociate the object from all TWGActiveConsoles. |
void |
DetachObjectFromConsole(TWGActiveConsole act_con)
Disassociate the object from the given TWGActiveConsole instance. |
java.lang.String |
GetConShadowClass()
Get name of console shadow class. |
byte[] |
GetShadowRecord(java.util.Locale locale)
Get buffer containing current values of the shadowed attributes to be delivered to the console shadow class. |
long |
GetShadowVersion()
Get object state version. |
java.lang.String |
getText(java.util.Locale loc)
Get text string resolved for given locale |
java.lang.String |
getTitle(java.util.Locale loc)
Get title string resolved for given locale |
static void |
handleAckPopupEventCmd(Command cmd)
Command handler for acknowledge popup command |
static void |
handleCancelPopupEventCmd(Command cmd)
Command handler for cancel popup command |
static void |
handleCreatePopupEventCmd(Command cmd)
Command handler for create popup event command |
void |
UpdateShadowVersion()
Update object state version. |
Methods inherited from class com.tivoli.twg.engine.TWGObject |
---|
AllObjects, AllObjects, Destroy, DumpTWGObjects, FindObject, isDeleted, isNewObject, isPersistent, isPersistent, isValid, isValid, ObjectID, setDistinctObjectID, SetObjectID |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public TWGPopupEvent()
public TWGPopupEvent(java.lang.String handler, java.lang.String nls_bndl, java.lang.String titl, java.lang.String txt, java.lang.Object[] prms, byte[] popup_prms, StringValueSet accounts, long timestmp)
handler
- - name of popup handler class for console to usenls_bndl
- - name of NLS ResourceBundle class for title and text
(if null, title and text fields will be used unmodified)titl
- - title string ID (if nls is non-null) or title format stringtxt
- - text string ID (if non-null NLS) or text format stringprms
- - parameters for title and text formattingpopup_prms
- - popup handler parameters, encoded as 4-byte count,
followed by list of encoded DataValue records (each preceded by
a 1-byte type field)accounts
- - targetted console accounts ('*' for all accounts)timestmp
- - timestamp for event (0 = current time)public TWGPopupEvent(java.lang.String handler, java.lang.String nls_bndl, java.lang.String titl, java.lang.String txt, java.lang.Object[] prms, byte[] popup_prms, StringValueSet accounts, long timestmp, boolean one_ack_only, boolean marque_display, boolean is_persist, boolean immed_only)
handler
- - name of popup handler class for console to usenls_bndl
- - name of NLS ResourceBundle class for title and text
(if null, title and text fields will be used unmodified)titl
- - title string ID (if nls is non-null) or title format stringtxt
- - text string ID (if non-null NLS) or text format stringprms
- - parameters for title and text formattingpopup_prms
- - popup handler parameters, encoded as 4-byte count,
followed by list of encoded DataValue records (each preceded by
a 1-byte type field)accounts
- - targetted console accounts ('*' for all accounts)timestmp
- - timestamp for event (0 = current time)one_ack_only
- - set to true if single acknowledge causes dismissmarque_display
- - set to true if marque display suggestedis_persist
- - set to true if event should be persistent until clearedimmed_only
- - set to true if event should only notify active usersMethod Detail |
public void Delete()
Delete
in class TWGObject
public void UpdateShadowVersion()
UpdateShadowVersion
in interface TWGBaseShadowedObject
public long GetShadowVersion()
GetShadowVersion
in interface TWGBaseShadowedObject
public java.lang.String GetConShadowClass()
GetConShadowClass
in interface TWGBaseShadowedObject
public byte[] GetShadowRecord(java.util.Locale locale)
GetShadowRecord
in interface TWGBaseShadowedObject
locale
- - Locale of requested data
public void AttachObjectToConsole(TWGActiveConsole act_con)
AttachObjectToConsole
in interface TWGConsoleSpecShadowedObject
act_con
- - Active console instance to be associated withpublic void DetachObjectFromConsole(TWGActiveConsole act_con)
DetachObjectFromConsole
in interface TWGConsoleSpecShadowedObject
act_con
- - Active console instance to be disassociated frompublic void DetachObjectFromAllConsoles()
DetachObjectFromAllConsoles
in interface TWGConsoleSpecShadowedObject
public java.lang.String getTitle(java.util.Locale loc)
loc
- - locale
public java.lang.String getText(java.util.Locale loc)
loc
- - locale
public void attachToActiveConsoles()
public static void attachEventsToConsole(TWGActiveConsole con)
con
- - active consolepublic static void handleCreatePopupEventCmd(Command cmd)
cmd
- - command requestedpublic static void handleCancelPopupEventCmd(Command cmd)
cmd
- - command requestedpublic static void handleAckPopupEventCmd(Command cmd)
cmd
- - command requested
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |