|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tivoli.twg.alertmgr.TWGActionInfo
Class for providing two-communication between the Director Event server and individual Event Handlers. Event Handlers use this structure to describe information about the Event Action. This information includes things like the title, the user customizable parameters, and what options they support. At runtime, this same object is used to the now customized instances of action parameters back into the handler during a specific invocation.
Constructor Summary | |
---|---|
TWGActionInfo()
Default Constructor for initial construction of the object prior to requesting information from Event Handler. |
|
TWGActionInfo(long userObjectId,
java.util.Locale conLocale)
Constructor for initializing info with console's Locale and User context. |
|
TWGActionInfo(long conUserId,
java.util.Locale conLocale,
java.lang.String tgtTimeZoneId,
java.util.Locale tgtLocale)
Constructor for initializing info with all console related settings. |
Method Summary | |
---|---|
void |
addParm(TWGActionParm ap)
Add an user customizable parameter to this Event Action. |
void |
disableTesting()
Indicate that Event Handler is not Testable. |
void |
enableTesting()
Indicate that Event Handler is Testable. |
java.util.Locale |
getConsoleLocale()
Get the locale of the console where Event Action was customized. |
long |
getConsoleUserId()
Get the userid of the console where Event Action was customized. |
long |
getCustomizationKey()
Get the customization key associated with a particular instance of the handler's data. |
long |
getLogKey()
Get the action log key for current invocation of the Event Handler's ProcessEvent method. |
int |
getNumParms()
Get the number of parameters for this Event Action. |
TWGActionParm |
getParm(int index)
Get the action parameter referenced by provided index. |
java.util.Locale |
getTargetLocale()
Get the designated locale of this target system. |
java.util.TimeZone |
getTargetTimeZone()
Get the time zone of this target system. |
java.lang.String |
getTargetTimeZoneID()
Get the time zone ID of this target system. |
java.lang.String |
getTitle()
Get the Event Handler's title (or associated bundle keyword if bundle non-null). |
java.lang.String |
getTitleBundle()
Get the bundle name associated with the Event Handler's title. |
void |
print()
Print the current contents of the ActionInfo object. |
void |
printFlags()
Print the current settings within the ActionInfo flags. |
void |
setConsoleLocale(java.util.Locale locale)
Set the locale of the console where Event Action was being customized. |
void |
setConsoleUserId(long userid)
Set the userid of the console where Event Action was customized. |
void |
setCustomizationKey(long key)
Set the customization key associated with a particular instance of the handler's data. |
void |
setExtendedLogging()
Indicate that Event Handler supports Action Logging. |
void |
setLogKey(long key)
Set the action log key for current invocation of the Event Handler's ProcessEvent method. |
void |
setPersistent()
Indicate that Event Handler should remain loaded after initialization. |
void |
setTargetLocale(java.util.Locale locale)
Set the desired locale of this target system. |
void |
setTargetTimeZoneID(java.lang.String tzID)
Set the time zone of this target system. |
void |
setTitle(java.lang.String t,
java.lang.String b)
Set the keyword and bundle name associated with the Event Handler's title. |
void |
setTitleBundle(java.lang.String b)
Set the bundle name associated with the Event Handler's title. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public TWGActionInfo()
public TWGActionInfo(long userObjectId, java.util.Locale conLocale)
conLocale
- locale of console userpublic TWGActionInfo(long conUserId, java.util.Locale conLocale, java.lang.String tgtTimeZoneId, java.util.Locale tgtLocale)
conLocale
- locale of console usertgtTimeZoneId
- timezone id of target usertgtLocale
- locale of target userMethod Detail |
public java.lang.String getTitle()
public java.lang.String getTitleBundle()
public void setTitleBundle(java.lang.String b)
b
- bundle namepublic void setTitle(java.lang.String t, java.lang.String b)
t
- keyword within the bundleb
- bundle namepublic java.util.Locale getConsoleLocale()
public void setConsoleLocale(java.util.Locale locale)
locale
- locale of the console systempublic long getConsoleUserId()
public void setConsoleUserId(long userid)
userid
- object id of console useridpublic java.util.Locale getTargetLocale()
public void setTargetLocale(java.util.Locale locale)
locale
- locale of the target systempublic java.lang.String getTargetTimeZoneID()
public java.util.TimeZone getTargetTimeZone()
public void setTargetTimeZoneID(java.lang.String tzID)
tzID
- time zone id of the target systempublic int getNumParms()
public void addParm(TWGActionParm ap)
ap
- action parameter to be addedpublic TWGActionParm getParm(int index)
index
- index of action parameter
public void setPersistent()
public void setExtendedLogging()
public void enableTesting()
public void disableTesting()
public long getLogKey()
public void setLogKey(long key)
key
- logging keypublic long getCustomizationKey()
public void setCustomizationKey(long key)
key
- - datstore keypublic void print()
public void printFlags()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |