|
|||||||||||
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.TWGPersistentObject
com.tivoli.twg.engine.TWGManagedObjectStatusGroup
Class for providing a related group of managed object status definitions. The group has a token name and presentation labels, as well as one or more status definitions. Each status definition includes a token ID, image set (for the small and large icons used for displaying the status), a descriptive label and hover text, status flags, and an optional task association. Managed object status definitions are associated or disassociated with a managed object by using the status set token ID and status definition token ID. The status set maintains a set of managed object IDs for tracking which managed objects have been associated with a given definition. The state of the status set is reflected to the console using the TWGConManagedObjectStatusGroup class.
Field Summary |
---|
Fields inherited from class com.tivoli.twg.engine.TWGPersistentObject |
---|
CLASS_NAME, SIZEOF_BYTE, SIZEOF_CHAR, SIZEOF_DOUBLE, SIZEOF_FLOAT, SIZEOF_INT, SIZEOF_LONG, SIZEOF_SHORT |
Constructor Summary | |
---|---|
TWGManagedObjectStatusGroup()
Default constructor - used during restore only |
|
TWGManagedObjectStatusGroup(java.lang.String id,
DataValue lab,
DataValue hover_str,
TWGExtension extension)
Standard constructor for creating a status set - need to call save() once object definition is complete to make definition persistent |
Method Summary | |
---|---|
void |
addStatusDefinition(java.lang.String id,
DataValue lab,
DataValue hover,
int flgs,
java.lang.String task_id,
java.lang.String subtask_id,
TWGImageSet img_set)
Add new status definition - need to call save() after updates complete |
void |
addStatusDefinition(java.lang.String id,
DataValue lab,
DataValue hover,
int flgs,
java.lang.String task_id,
java.lang.String subtask_id,
TWGImageSet img_set,
int sev,
int sortwt)
Add new status definition - need to call save() after updates complete |
void |
Delete()
Handle delete of object |
boolean |
deleteStatusDefinition(java.lang.String id)
Delete status definition - need to call save() after updates complete |
static TWGManagedObjectStatusGroup |
findStatusGroup(java.lang.String id)
Find status group with given ID |
static TWGManagedObjectStatusGroup[] |
getAllStatusGroups()
Get all status groups |
java.lang.String[] |
getAllStatusIDs()
Get all status definition IDs |
java.lang.String |
getAttributeDescription(java.lang.String id,
java.util.Locale loc)
Get description string for given attribute in given locale |
java.lang.String[] |
getAttributeIDList()
Attribute ID enumeration : this method is expected to return a List of strings containing the String names of the attributes supported for a given object. |
int |
getAttributeType(java.lang.String id)
Get type of attribute value for given attribute |
DataValue |
getAttributeValue(java.lang.String id,
java.util.Locale loc)
Get value of attribute with given ID |
java.lang.String |
getAttributeValueString(java.lang.String id,
java.util.Locale loc)
Get descriptive value string for given attribute in given locale |
java.lang.String |
GetConShadowClass()
Get name of console shadow class. |
java.lang.String |
getExtensionClassname()
Get extension class associated with status group |
int |
getGroupFlags()
Get status group flags |
DataValue |
getGroupHoverHelp()
Get status group hover help, as DataValue |
java.lang.String |
getGroupHoverHelp(java.util.Locale loc)
Get status group hover help for given locale |
java.lang.String |
getGroupID()
Get status group token ID |
TWGImageSet |
getGroupImageSet()
Get group image set |
DataValue |
getGroupLabel()
Get status group label, as DataValue |
java.lang.String |
getGroupLabel(java.util.Locale loc)
Get status group label for given locale |
int |
getGroupSortWeight()
Get status group sort weight |
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. |
TWGImageSet |
getStatusImageSet(java.lang.String id)
Get status image set for status definition with given ID |
DataValue |
getStatusLabel(java.lang.String id)
Get status label for status definition with given ID |
static boolean |
isValidStatusDefinition(java.lang.String grp_id,
java.lang.String stat_id)
Test if given group ID and definition ID are valid |
protected void |
restoreData(TWGPersistentObjectDictionary dictionary,
boolean resolveObjectReferences)
Method for restoring persistent object data. |
protected void |
saveData(TWGPersistentObjectDictionary dictionary)
Method for saving persistent object data. |
boolean |
setAttributeValue(java.lang.String id,
DataValue val)
Set value of attribute with given ID |
void |
setExtensionClassname(java.lang.String ext)
Set extension class associated with status group - need to call save() after updates complete |
void |
setGroupFlags(int f)
Set status group flags - need to call save() after updates complete |
void |
setGroupHoverHelp(DataValue lab)
Set status group hover help - need to call save() after updates complete |
void |
setGroupImageSet(TWGImageSet img)
Set group image set - need to call save() after updates complete |
void |
setGroupLabel(DataValue lab)
Set status group label - need to call save() after updates complete |
void |
setGroupSortWeight(int sw)
Set status group sort weight - need to call save() after updates complete |
void |
UpdateShadowVersion()
Update object state version. |
Methods inherited from class com.tivoli.twg.engine.TWGPersistentObject |
---|
Destroy, enableAsyncWrites, fromPersistID, initialize, isNewPersistentStore, isSaveRequired, PersistID, restore, restoreAll, save, save, setSaveRequired, terminate, toPersistID |
Methods inherited from class com.tivoli.twg.engine.TWGObject |
---|
AllObjects, AllObjects, 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 TWGManagedObjectStatusGroup()
public TWGManagedObjectStatusGroup(java.lang.String id, DataValue lab, DataValue hover_str, TWGExtension extension) throws DuplicateObjectIDException
id
- - token ID for status group (must be unique)lab
- - Display label/name for status sethover_str
- - Hover help string for status set (if null, lab is used)extension
- - Extension associated with status set (set will be dropped
when extension is not active), null if none
DuplicateObjectIDExtension
- if token ID is match with existing set
DuplicateObjectIDException
Method Detail |
public void Delete()
Delete
in class TWGObject
protected void saveData(TWGPersistentObjectDictionary dictionary) throws TWGPersistentObjectSaveException
saveData
in class TWGPersistentObject
TWGPersistentObjectSaveException
- thrown to abort save procedure.protected void restoreData(TWGPersistentObjectDictionary dictionary, boolean resolveObjectReferences) throws TWGPersistentObjectRestoreException
restoreData
in class TWGPersistentObject
resolveObjectReferences
- used to indicate if object references should be
resolved during restore.
TWGPersistentObjectRestoreException
- thrown to abort restore procedure.public static boolean isValidStatusDefinition(java.lang.String grp_id, java.lang.String stat_id)
grp_id
- - token ID for status groupstat_id
- - token ID for status definition
public static TWGManagedObjectStatusGroup findStatusGroup(java.lang.String id)
id
- - status group ID
public static TWGManagedObjectStatusGroup[] getAllStatusGroups()
public java.lang.String[] getAllStatusIDs()
public DataValue getStatusLabel(java.lang.String id)
id
- - status ID
public TWGImageSet getStatusImageSet(java.lang.String id)
id
- - status ID
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 DataValue getGroupLabel()
public java.lang.String getGroupLabel(java.util.Locale loc)
loc
- - locale to resolve label to
public void setGroupLabel(DataValue lab)
lab
- - new value for status group labelpublic DataValue getGroupHoverHelp()
public java.lang.String getGroupHoverHelp(java.util.Locale loc)
loc
- - locale to resolve label to
public void setGroupHoverHelp(DataValue lab)
lab
- - new value for status group hover helppublic java.lang.String getGroupID()
public java.lang.String getExtensionClassname()
public void setExtensionClassname(java.lang.String ext)
ext
- - extension classnamepublic int getGroupFlags()
public void setGroupFlags(int f)
f
- - new flags valuepublic int getGroupSortWeight()
public void setGroupSortWeight(int sw)
sw
- - new sort weight valuepublic TWGImageSet getGroupImageSet()
public void setGroupImageSet(TWGImageSet img)
img
- - image set
InvalidObjectIDException
- if invalid image setpublic void addStatusDefinition(java.lang.String id, DataValue lab, DataValue hover, int flgs, java.lang.String task_id, java.lang.String subtask_id, TWGImageSet img_set, int sev, int sortwt) throws DuplicateObjectIDException
id
- - status definition ID (must be unique within status group)lab
- - status definition labelhover
- - status definition hover helpflgs
- - status definition flagstask_id
- - task ID of task associated with definition, null if nonesubtask_id
- - subtask ID of subtask associated with definition, null if noneimg_set
- - image set for status definitionsev
- - severity of status (STATUS_SEVERITY_*)sortwt
- - sort weight of status
DuplicateObjectIDException
- if ID already existspublic void addStatusDefinition(java.lang.String id, DataValue lab, DataValue hover, int flgs, java.lang.String task_id, java.lang.String subtask_id, TWGImageSet img_set) throws DuplicateObjectIDException
id
- - status definition ID (must be unique within status group)lab
- - status definition labelhover
- - status definition hover helpflgs
- - status definition flagstask_id
- - task ID of task associated with definition, null if nonesubtask_id
- - subtask ID of subtask associated with definition, null if noneimg_set
- - image set for status definition
DuplicateObjectIDException
- if ID already existspublic boolean deleteStatusDefinition(java.lang.String id)
id
- - ID of status definition to drop
public java.lang.String[] getAttributeIDList()
getAttributeIDList
in interface TWGGetSetInterface
public DataValue getAttributeValue(java.lang.String id, java.util.Locale loc)
getAttributeValue
in interface TWGGetSetInterface
id
- - attribute ID requestedloc
- - locale to use for value, if applicable
public boolean setAttributeValue(java.lang.String id, DataValue val)
setAttributeValue
in interface TWGGetSetInterface
id
- - attribute ID to be setval
- - attribute value to be set
public int getAttributeType(java.lang.String id)
getAttributeType
in interface TWGGetSetInterface
id
- - attribute ID
public java.lang.String getAttributeDescription(java.lang.String id, java.util.Locale loc)
getAttributeDescription
in interface TWGGetSetDescInterface
id
- - attribute IDloc
- - locale to use for description
public java.lang.String getAttributeValueString(java.lang.String id, java.util.Locale loc)
getAttributeValueString
in interface TWGGetSetDescInterface
id
- - attribute IDloc
- - locale to use for description
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |