|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tivoli.twg.alertmgr.TWGPublish
com.tivoli.twg.alertmgr.TWGPublishDetail
PublishDetail objects are meant to be used as a publishing mechanism for the Event detail labels and references that would otherwise be retransmitted each time the on event was sent. The event generator assigns an id to be used henceforth when generating the actual events. Multiple detail objects may be included in one publishEventDetail. The family and qualifiers are used to convey the scope of the detail being published. This way, one detail id could be used to publish label and reference information for all Director events (assuing family = Director, qualifiers = null). In general, this will be the desireable approach. However, should there be conflict, a more detailed publishing (ie. more qualifiers) could be used. Version is available so that data stored at the server may be replaced over time by new translatable text.
Field Summary |
---|
Fields inherited from class com.tivoli.twg.alertmgr.TWGPublish |
---|
VERSION_ONE |
Constructor Summary | |
---|---|
TWGPublishDetail(IntelByteBuffer buf)
Constructor for interpreting a provided IntelByteBuffer. |
|
TWGPublishDetail(IntelByteBuffer buf,
int off)
Constructor for interpreting a provided IntelByteBuffer at a given offset. |
|
TWGPublishDetail(java.lang.String family,
java.lang.String[] qualifiers,
int version,
java.util.Locale locale)
Constructor. |
|
TWGPublishDetail(java.lang.String family,
java.lang.String[] qualifiers,
java.util.Locale locale)
Constructor with default version. |
|
TWGPublishDetail(TWGPublishDetail pd)
Copy Constructor. |
Method Summary | |
---|---|
void |
addDetail(TWGDetail detail)
Add a TWGDetail object to the publication. |
java.lang.Object |
clone()
Copy object. |
TWGDetail |
getDetail(int index)
Get a TWGDetail object refernced by index. |
java.util.Vector |
getDetails()
Get a reference to the list TWGDetail objects within the publication. |
int |
getNumDetails()
Get a the number TWGDetail objects within the publication. |
int |
getTypeId()
Get type ID. |
int |
readTWGPublishDetail(IntelByteBuffer buf,
int off)
Method for interpreting a provided IntelByteBuffer at a given offset. |
int |
sizeOf()
Determine the size of the entire TWGPublishDetail object. |
static int |
sizeOfHdr()
Determine the size of the TWGPublishDetail header. |
int |
sizeOfTWGPublishDetail()
Determine the size of the entire TWGPublishDetail object. |
IntelByteBuffer |
toIntelByteBuffer()
Convert the TWGPublishDetail into IntelByteBuffer representation. |
int |
writeIntelByteBuffer(IntelByteBuffer buf)
Write contents of this object into an IntelByteBuffer. |
int |
writeIntelByteBuffer(IntelByteBuffer buf,
int off)
Write contents of this object into provided IntelByteBuffer starting at a given offset. |
Methods inherited from class com.tivoli.twg.alertmgr.TWGPublish |
---|
getLocale, getNumTypeQualifiers, getType, getTypeArray, getTypeFamily, getTypeQualifiers, getVersion, print, readTWGPublish, setLocale, setVersion, sizeOfTWGPublish |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public TWGPublishDetail(java.lang.String family, java.lang.String[] qualifiers, int version, java.util.Locale locale)
family
- String representing the highest level qualifier of the event typequalifiers
- Array of strings comprising the remainder of the event typeversion
- Version of data being publishedlocale
- Locale of data being publishedpublic TWGPublishDetail(java.lang.String family, java.lang.String[] qualifiers, java.util.Locale locale)
family
- String representing the highest level qualifier of the event typequalifiers
- Array of strings comprising the remainder of the event typelocale
- Locale of data being publishedpublic TWGPublishDetail(TWGPublishDetail pd)
pd
- TWGPublishDetail object to be copiedpublic TWGPublishDetail(IntelByteBuffer buf)
buf
- IntelByteBuffer from which data should be readpublic TWGPublishDetail(IntelByteBuffer buf, int off)
buf
- IntelByteBuffer from which data should be readoff
- offset from the current relative start of the provided IntelByteBufferMethod Detail |
public java.lang.Object clone()
clone
in class TWGPublish
public void addDetail(TWGDetail detail)
detail
- detail object to be addedpublic java.util.Vector getDetails()
public int getNumDetails()
public TWGDetail getDetail(int index) throws com.tivoli.twg.alertmgr.TWGOutOfBoundsException
index
- index of requested object
com.tivoli.twg.alertmgr.TWGOutOfBoundsException
public IntelByteBuffer toIntelByteBuffer()
toIntelByteBuffer
in class TWGPublish
public int writeIntelByteBuffer(IntelByteBuffer buf)
writeIntelByteBuffer
in class TWGPublish
buf
- IntelByteBuffer into which data should be written
public int writeIntelByteBuffer(IntelByteBuffer buf, int off)
writeIntelByteBuffer
in class TWGPublish
buf
- IntelByteBuffer into which data should be writtenoff
- offset from the current relative start of the provided IntelByteBuffer
public int readTWGPublishDetail(IntelByteBuffer buf, int off)
buf
- IntelByteBuffer from which data should be readoff
- offset from the current relative start of the provided IntelByteBuffer
public static int sizeOfHdr()
public int sizeOfTWGPublishDetail()
public int sizeOf()
sizeOf
in class TWGPublish
public int getTypeId()
getTypeId
in class TWGPublish
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |