com.tivoli.twg.engine
Class TWGConPopupEvent

java.lang.Object
  extended bycom.tivoli.twg.engine.TWGConObject
      extended bycom.tivoli.twg.engine.TWGConPopupEvent

public class TWGConPopupEvent
extends TWGConObject

Console object used to shadow the state of a TWGPopupEvent object in the Director Server.


Field Summary
 
Fields inherited from class com.tivoli.twg.engine.TWGConObject
INVALID_OBJECT_ID
 
Constructor Summary
TWGConPopupEvent(long obj_id)
          Constructor for TWGConPopupEvent with given object ID
 
Method Summary
 java.lang.String getPopupHandlerClassname()
          Get popup handler classname
 DataValue[] getPopupParameters()
          Get popup handler parameter list
 java.lang.String getText()
          Get text string
 java.util.Date getTimestamp()
          Get timestamp
 java.lang.String getTitle()
          Get title string
 boolean isASAPEvent()
          Test to see if event is ASAP display (as opposed to immediate only)
 boolean isMarqueSuggested()
          Test to see if marque display is suggested
 boolean isPersistentEvent()
          Test to see if persistent event
 boolean isSingleAckDismiss()
          Test to see if single-acknowledge dismiss event
 java.lang.String toString()
          Generate string representation of object
 void UpdateUsingShadowRecord(byte[] buf, int rec_off, int rec_len)
          Update object using shadow record created by the the engine object which is matched with this class.
 
Methods inherited from class com.tivoli.twg.engine.TWGConObject
AllObjects, AllObjects, Delete, DeleteObjects, DeregisterListener, FindObject, getBaseClassName, LookUpShadowClass, ObjectID, ProcessUpdateRequest, RegisterListener, SetObjectID
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TWGConPopupEvent

public TWGConPopupEvent(long obj_id)
                 throws DuplicateObjectIDException
Constructor for TWGConPopupEvent with given object ID

Parameters:
obj_id - - object ID of console object
Throws:
DuplicateObjectIDException - if ID is duplicate of existing object ID
Method Detail

UpdateUsingShadowRecord

public void UpdateUsingShadowRecord(byte[] buf,
                                    int rec_off,
                                    int rec_len)
Update object using shadow record created by the the engine object which is matched with this class.

Specified by:
UpdateUsingShadowRecord in class TWGConObject
Parameters:
buf - - byte array containing opaque representation of shadowed attributes
rec_off - - offset of shadow record in byte array
rec_len - - length of shadow record in byte array

toString

public java.lang.String toString()
Generate string representation of object

Overrides:
toString in class TWGConObject
Returns:
string representation

getTitle

public java.lang.String getTitle()
Get title string

Returns:
title string

getText

public java.lang.String getText()
Get text string

Returns:
text string

getPopupHandlerClassname

public java.lang.String getPopupHandlerClassname()
Get popup handler classname

Returns:
popup handler classname

getTimestamp

public java.util.Date getTimestamp()
Get timestamp

Returns:
event timestamp

getPopupParameters

public DataValue[] getPopupParameters()
Get popup handler parameter list

Returns:
popup handler parameter list (or null if none)

isMarqueSuggested

public boolean isMarqueSuggested()
Test to see if marque display is suggested

Returns:
true if marque suggested

isSingleAckDismiss

public boolean isSingleAckDismiss()
Test to see if single-acknowledge dismiss event

Returns:
true if event dismissed by first acknowledge

isPersistentEvent

public boolean isPersistentEvent()
Test to see if persistent event

Returns:
true if event is persistent

isASAPEvent

public boolean isASAPEvent()
Test to see if event is ASAP display (as opposed to immediate only)

Returns:
true if event is ASAP display