com.novell.db.object.bean
Class CorrelatedEventsBean

java.lang.Object
  extended by com.novell.sentinel.client.bean.SentinelBean
      extended by com.novell.db.object.bean.CorrelatedEventsBean

public class CorrelatedEventsBean
extends SentinelBean

An automatically-generated "bean" class for the Sentinel data object type 'trigger-events'.

The description of the type is:

"Associates a correlation event with the events that triggered the correlation event."

The Sentinel data object bean classes are designed to be used to transport data to and from the Sentinel server. There exists a supporting infrastructure that handles the serialization/parsing of the data to/from the JSON transport format and which handles the actual HTTP transport.

A more complete description of Sentinel data object beans is found in the description of SentinelBean.

See Also:
SentinelBean, BeanTransporter

Field Summary
static String CHILD_EVT_ID
          The "bean name" of the Sentinel data object field 'ChildEvtId'.
static String CHILD_EVT_TIME
          The "bean name" of the Sentinel data object field 'ChildEvtTime'.
static String CREATOR
          The "bean name" of the Sentinel data object field 'Creator'.
static String DATE_CREATED
          The "bean name" of the Sentinel data object field 'DateCreated'.
static String DATE_MODIFIED
          The "bean name" of the Sentinel data object field 'DateModified'.
static String FOUND
          The "bean name" of the Sentinel data object field 'Found'.
static String MODIFIER
          The "bean name" of the Sentinel data object field 'Modifier'.
static String PARENT_EVT_ID
          The "bean name" of the Sentinel data object field 'ParentEvtId'.
static String PARENT_EVT_TIME
          The "bean name" of the Sentinel data object field 'ParentEvtTime'.
 
Constructor Summary
  CorrelatedEventsBean()
          Construct an instance of the bean class.
protected CorrelatedEventsBean(BeanMetaData<? extends SentinelBean> metadata)
          Constructor for use by derived classes.
 
Method Summary
 void clearChildEvtId()
          Clear any current value for the 'child-id' field in the bean.
 void clearChildEvtTime()
          Clear any current value for the 'child-time' field in the bean.
 void clearFound()
          Clear any current value for the 'Found' field in the bean.
 void clearParentEvtId()
          Clear any current value for the 'parent-id' field in the bean.
 void clearParentEvtTime()
          Clear any current value for the 'parent-time' field in the bean.
 CorrelatedEventsBean clone()
          Create a duplicate of this bean instance, including all field values.
static BeanMetaData<? extends CorrelatedEventsBean> getBeanMetaData()
          Get the metadata class instance for this type.
 String getChildEvtId()
          Get the value for the 'child-id' field.
 Date getChildEvtTime()
          Get the value for the 'child-time' field.
 String getCreatorLink()
          Get the URL for the 'creator' field.
 Date getDateCreated()
          Get the value for the 'createdate' field.
 Date getDateModified()
          Get the value for the 'moddate' field.
 String getModifierLink()
          Get the URL for the 'modifier' field.
 String getParentEvtId()
          Get the value for the 'parent-id' field.
 Date getParentEvtTime()
          Get the value for the 'parent-time' field.
 boolean isChildEvtIdClear()
          Get whether the value for the 'child-id' field is clear or not.
 boolean isChildEvtIdNull()
          Get whether the 'child-id' field has been set to Null or not.
 boolean isChildEvtTimeClear()
          Get whether the value for the 'child-time' field is clear or not.
 boolean isChildEvtTimeNull()
          Get whether the 'child-time' field has been set to Null or not.
 boolean isCreatorLinkClear()
          Get whether the value for the 'creator' URL field is clear or not.
 boolean isCreatorLinkNull()
          Get whether the 'creator' URL field has been set to Null or not.
 boolean isDateCreatedClear()
          Get whether the value for the 'createdate' field is clear or not.
 boolean isDateCreatedNull()
          Get whether the 'createdate' field has been set to Null or not.
 boolean isDateModifiedClear()
          Get whether the value for the 'moddate' field is clear or not.
 boolean isDateModifiedNull()
          Get whether the 'moddate' field has been set to Null or not.
 boolean isFound()
          Get the value for the 'Found' field.
 boolean isFoundClear()
          Get whether the value for the 'Found' field is clear or not.
 boolean isFoundNull()
          Get whether the 'Found' field has been set to Null or not.
 boolean isModifierLinkClear()
          Get whether the value for the 'modifier' URL field is clear or not.
 boolean isModifierLinkNull()
          Get whether the 'modifier' URL field has been set to Null or not.
 boolean isParentEvtIdClear()
          Get whether the value for the 'parent-id' field is clear or not.
 boolean isParentEvtIdNull()
          Get whether the 'parent-id' field has been set to Null or not.
 boolean isParentEvtTimeClear()
          Get whether the value for the 'parent-time' field is clear or not.
 boolean isParentEvtTimeNull()
          Get whether the 'parent-time' field has been set to Null or not.
 void setChildEvtId(String childEvtId)
          Set the value for the 'child-id' field.
 void setChildEvtIdNull()
          Set to Null any current value for the 'child-id' field in the bean.
 void setChildEvtTime(Date childEvtTime)
          Set the value for the 'child-time' field.
 void setChildEvtTimeNull()
          Set to Null any current value for the 'child-time' field in the bean.
 void setFound(boolean found)
          Set the value for the 'Found' field.
 void setFoundNull()
          Set to Null any current value for the 'Found' field in the bean.
 void setParentEvtId(String parentEvtId)
          Set the value for the 'parent-id' field.
 void setParentEvtIdNull()
          Set to Null any current value for the 'parent-id' field in the bean.
 void setParentEvtTime(Date parentEvtTime)
          Set the value for the 'parent-time' field.
 void setParentEvtTimeNull()
          Set to Null any current value for the 'parent-time' field in the bean.
 
Methods inherited from class com.novell.sentinel.client.bean.SentinelBean
clearField, cloneBean, equals, fields, getBeanName, getBeanValue, getField, getFieldNoNull, getLink, getMetaData, isFieldClear, isFieldNull, isLinkClear, setField, setFieldNull, toString, values
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CHILD_EVT_ID

public static final String CHILD_EVT_ID
The "bean name" of the Sentinel data object field 'ChildEvtId'. The value is ""child-id"".

The description of the 'child-id' field is:

"The unique ID of an event that triggered the correlated event."

See Also:
Constant Field Values

DATE_MODIFIED

public static final String DATE_MODIFIED
The "bean name" of the Sentinel data object field 'DateModified'. The value is ""moddate"".

The description of the 'moddate' field is:

"The date and time when the object was last modified."

See Also:
Constant Field Values

CHILD_EVT_TIME

public static final String CHILD_EVT_TIME
The "bean name" of the Sentinel data object field 'ChildEvtTime'. The value is ""child-time"".

The description of the 'child-time' field is:

"The time of the event that triggered the correlated event."

See Also:
Constant Field Values

PARENT_EVT_TIME

public static final String PARENT_EVT_TIME
The "bean name" of the Sentinel data object field 'ParentEvtTime'. The value is ""parent-time"".

The description of the 'parent-time' field is:

"The time of the correlated event."

See Also:
Constant Field Values

CREATOR

public static final String CREATOR
The "bean name" of the Sentinel data object field 'Creator'. The value is ""creator"".

The description of the 'creator' field is:

"The URL of the Sentinel User object that represents the creator of the object."

See Also:
Constant Field Values

MODIFIER

public static final String MODIFIER
The "bean name" of the Sentinel data object field 'Modifier'. The value is ""modifier"".

The description of the 'modifier' field is:

"The URL of the Sentinel User object that represents the last modifier of the object."

See Also:
Constant Field Values

DATE_CREATED

public static final String DATE_CREATED
The "bean name" of the Sentinel data object field 'DateCreated'. The value is ""createdate"".

The description of the 'createdate' field is:

"The date and time when the object was created."

See Also:
Constant Field Values

PARENT_EVT_ID

public static final String PARENT_EVT_ID
The "bean name" of the Sentinel data object field 'ParentEvtId'. The value is ""parent-id"".

The description of the 'parent-id' field is:

"The unique ID for the correlated event."

See Also:
Constant Field Values

FOUND

public static final String FOUND
The "bean name" of the Sentinel data object field 'Found'. The value is ""Found"".

The description of the 'Found' field is:

"Flag indicating if trigger event is still available in an online event partition."

See Also:
Constant Field Values
Constructor Detail

CorrelatedEventsBean

public CorrelatedEventsBean()
Construct an instance of the bean class.


CorrelatedEventsBean

protected CorrelatedEventsBean(BeanMetaData<? extends SentinelBean> metadata)
Constructor for use by derived classes.

Parameters:
metadata - The metadata instance for the derived bean class. Normally this constructor will only be called by generated code.
Method Detail

getParentEvtTime

public Date getParentEvtTime()
Get the value for the 'parent-time' field. The description of the 'parent-time' field is:

"The time of the correlated event."

Returns:
The field's value in the bean instance, if any (may return null).
See Also:
PARENT_EVT_TIME

isParentEvtTimeNull

public boolean isParentEvtTimeNull()
Get whether the 'parent-time' field has been set to Null or not. The description of the 'parent-time' field is:

"The time of the correlated event."

See the description of Null values.

Returns:
true if the field value has been marked as null, false otherwise.
See Also:
setParentEvtTimeNull(), PARENT_EVT_TIME

isParentEvtTimeClear

public boolean isParentEvtTimeClear()
Get whether the value for the 'parent-time' field is clear or not. The description of the 'parent-time' field is:

"The time of the correlated event."

See the description of cleared values.

Returns:
true if the field value has been cleared, false otherwise.
See Also:
clearParentEvtTime(), PARENT_EVT_TIME

setParentEvtTime

public void setParentEvtTime(Date parentEvtTime)
Set the value for the 'parent-time' field. The description of the 'parent-time' field is:

"The time of the correlated event."

Parameters:
parentEvtTime - Value to set
See Also:
PARENT_EVT_TIME

clearParentEvtTime

public void clearParentEvtTime()
Clear any current value for the 'parent-time' field in the bean. The description of the 'parent-time' field is:

"The time of the correlated event."

Using this method will not clear the server value when the bean is PUT to the server. Use the setParentEvtTimeNull() method to clear the server's value.

See the description of cleared values.

See Also:
PARENT_EVT_TIME

setParentEvtTimeNull

public void setParentEvtTimeNull()
Set to Null any current value for the 'parent-time' field in the bean. The description of the 'parent-time' field is:

"The time of the correlated event."

Using this method will clear the server value when the bean is PUT to the server. Use the clearParentEvtTime() method to avoid clearing the server's value.

See the description of Null values.

See Also:
PARENT_EVT_TIME

getParentEvtId

public String getParentEvtId()
Get the value for the 'parent-id' field. The description of the 'parent-id' field is:

"The unique ID for the correlated event."

Returns:
The field's value in the bean instance, if any (may return null).
See Also:
PARENT_EVT_ID

isParentEvtIdNull

public boolean isParentEvtIdNull()
Get whether the 'parent-id' field has been set to Null or not. The description of the 'parent-id' field is:

"The unique ID for the correlated event."

See the description of Null values.

Returns:
true if the field value has been marked as null, false otherwise.
See Also:
setParentEvtIdNull(), PARENT_EVT_ID

isParentEvtIdClear

public boolean isParentEvtIdClear()
Get whether the value for the 'parent-id' field is clear or not. The description of the 'parent-id' field is:

"The unique ID for the correlated event."

See the description of cleared values.

Returns:
true if the field value has been cleared, false otherwise.
See Also:
clearParentEvtId(), PARENT_EVT_ID

setParentEvtId

public void setParentEvtId(String parentEvtId)
Set the value for the 'parent-id' field. The description of the 'parent-id' field is:

"The unique ID for the correlated event."

Parameters:
parentEvtId - Value to set
See Also:
PARENT_EVT_ID

clearParentEvtId

public void clearParentEvtId()
Clear any current value for the 'parent-id' field in the bean. The description of the 'parent-id' field is:

"The unique ID for the correlated event."

Using this method will not clear the server value when the bean is PUT to the server. Use the setParentEvtIdNull() method to clear the server's value.

See the description of cleared values.

See Also:
PARENT_EVT_ID

setParentEvtIdNull

public void setParentEvtIdNull()
Set to Null any current value for the 'parent-id' field in the bean. The description of the 'parent-id' field is:

"The unique ID for the correlated event."

Using this method will clear the server value when the bean is PUT to the server. Use the clearParentEvtId() method to avoid clearing the server's value.

See the description of Null values.

See Also:
PARENT_EVT_ID

getDateModified

public Date getDateModified()
Get the value for the 'moddate' field. The description of the 'moddate' field is:

"The date and time when the object was last modified."

Returns:
The field's value in the bean instance, if any (may return null).
See Also:
DATE_MODIFIED

isDateModifiedNull

public boolean isDateModifiedNull()
Get whether the 'moddate' field has been set to Null or not. The description of the 'moddate' field is:

"The date and time when the object was last modified."

See the description of Null values.

Returns:
true if the field value has been marked as null, false otherwise.
See Also:
DATE_MODIFIED

isDateModifiedClear

public boolean isDateModifiedClear()
Get whether the value for the 'moddate' field is clear or not. The description of the 'moddate' field is:

"The date and time when the object was last modified."

See the description of cleared values.

Returns:
true if the field value has been cleared, false otherwise.
See Also:
DATE_MODIFIED

getChildEvtTime

public Date getChildEvtTime()
Get the value for the 'child-time' field. The description of the 'child-time' field is:

"The time of the event that triggered the correlated event."

Returns:
The field's value in the bean instance, if any (may return null).
See Also:
CHILD_EVT_TIME

isChildEvtTimeNull

public boolean isChildEvtTimeNull()
Get whether the 'child-time' field has been set to Null or not. The description of the 'child-time' field is:

"The time of the event that triggered the correlated event."

See the description of Null values.

Returns:
true if the field value has been marked as null, false otherwise.
See Also:
setChildEvtTimeNull(), CHILD_EVT_TIME

isChildEvtTimeClear

public boolean isChildEvtTimeClear()
Get whether the value for the 'child-time' field is clear or not. The description of the 'child-time' field is:

"The time of the event that triggered the correlated event."

See the description of cleared values.

Returns:
true if the field value has been cleared, false otherwise.
See Also:
clearChildEvtTime(), CHILD_EVT_TIME

setChildEvtTime

public void setChildEvtTime(Date childEvtTime)
Set the value for the 'child-time' field. The description of the 'child-time' field is:

"The time of the event that triggered the correlated event."

Parameters:
childEvtTime - Value to set
See Also:
CHILD_EVT_TIME

clearChildEvtTime

public void clearChildEvtTime()
Clear any current value for the 'child-time' field in the bean. The description of the 'child-time' field is:

"The time of the event that triggered the correlated event."

Using this method will not clear the server value when the bean is PUT to the server. Use the setChildEvtTimeNull() method to clear the server's value.

See the description of cleared values.

See Also:
CHILD_EVT_TIME

setChildEvtTimeNull

public void setChildEvtTimeNull()
Set to Null any current value for the 'child-time' field in the bean. The description of the 'child-time' field is:

"The time of the event that triggered the correlated event."

Using this method will clear the server value when the bean is PUT to the server. Use the clearChildEvtTime() method to avoid clearing the server's value.

See the description of Null values.

See Also:
CHILD_EVT_TIME

getDateCreated

public Date getDateCreated()
Get the value for the 'createdate' field. The description of the 'createdate' field is:

"The date and time when the object was created."

Returns:
The field's value in the bean instance, if any (may return null).
See Also:
DATE_CREATED

isDateCreatedNull

public boolean isDateCreatedNull()
Get whether the 'createdate' field has been set to Null or not. The description of the 'createdate' field is:

"The date and time when the object was created."

See the description of Null values.

Returns:
true if the field value has been marked as null, false otherwise.
See Also:
DATE_CREATED

isDateCreatedClear

public boolean isDateCreatedClear()
Get whether the value for the 'createdate' field is clear or not. The description of the 'createdate' field is:

"The date and time when the object was created."

See the description of cleared values.

Returns:
true if the field value has been cleared, false otherwise.
See Also:
DATE_CREATED

isFound

public boolean isFound()
Get the value for the 'Found' field. The description of the 'Found' field is:

"Flag indicating if trigger event is still available in an online event partition."

Returns:
The field's value in the bean instance, if any (may return null).
See Also:
FOUND

isFoundNull

public boolean isFoundNull()
Get whether the 'Found' field has been set to Null or not. The description of the 'Found' field is:

"Flag indicating if trigger event is still available in an online event partition."

See the description of Null values.

Returns:
true if the field value has been marked as null, false otherwise.
See Also:
setFoundNull(), FOUND

isFoundClear

public boolean isFoundClear()
Get whether the value for the 'Found' field is clear or not. The description of the 'Found' field is:

"Flag indicating if trigger event is still available in an online event partition."

See the description of cleared values.

Returns:
true if the field value has been cleared, false otherwise.
See Also:
clearFound(), FOUND

setFound

public void setFound(boolean found)
Set the value for the 'Found' field. The description of the 'Found' field is:

"Flag indicating if trigger event is still available in an online event partition."

Parameters:
found - Value to set
See Also:
FOUND

clearFound

public void clearFound()
Clear any current value for the 'Found' field in the bean. The description of the 'Found' field is:

"Flag indicating if trigger event is still available in an online event partition."

Using this method will not clear the server value when the bean is PUT to the server. Use the setFoundNull() method to clear the server's value.

See the description of cleared values.

See Also:
FOUND

setFoundNull

public void setFoundNull()
Set to Null any current value for the 'Found' field in the bean. The description of the 'Found' field is:

"Flag indicating if trigger event is still available in an online event partition."

Using this method will clear the server value when the bean is PUT to the server. Use the clearFound() method to avoid clearing the server's value.

See the description of Null values.

See Also:
FOUND

getChildEvtId

public String getChildEvtId()
Get the value for the 'child-id' field. The description of the 'child-id' field is:

"The unique ID of an event that triggered the correlated event."

Returns:
The field's value in the bean instance, if any (may return null).
See Also:
CHILD_EVT_ID

isChildEvtIdNull

public boolean isChildEvtIdNull()
Get whether the 'child-id' field has been set to Null or not. The description of the 'child-id' field is:

"The unique ID of an event that triggered the correlated event."

See the description of Null values.

Returns:
true if the field value has been marked as null, false otherwise.
See Also:
setChildEvtIdNull(), CHILD_EVT_ID

isChildEvtIdClear

public boolean isChildEvtIdClear()
Get whether the value for the 'child-id' field is clear or not. The description of the 'child-id' field is:

"The unique ID of an event that triggered the correlated event."

See the description of cleared values.

Returns:
true if the field value has been cleared, false otherwise.
See Also:
clearChildEvtId(), CHILD_EVT_ID

setChildEvtId

public void setChildEvtId(String childEvtId)
Set the value for the 'child-id' field. The description of the 'child-id' field is:

"The unique ID of an event that triggered the correlated event."

Parameters:
childEvtId - Value to set
See Also:
CHILD_EVT_ID

clearChildEvtId

public void clearChildEvtId()
Clear any current value for the 'child-id' field in the bean. The description of the 'child-id' field is:

"The unique ID of an event that triggered the correlated event."

Using this method will not clear the server value when the bean is PUT to the server. Use the setChildEvtIdNull() method to clear the server's value.

See the description of cleared values.

See Also:
CHILD_EVT_ID

setChildEvtIdNull

public void setChildEvtIdNull()
Set to Null any current value for the 'child-id' field in the bean. The description of the 'child-id' field is:

"The unique ID of an event that triggered the correlated event."

Using this method will clear the server value when the bean is PUT to the server. Use the clearChildEvtId() method to avoid clearing the server's value.

See the description of Null values.

See Also:
CHILD_EVT_ID

getModifierLink

public String getModifierLink()
Get the URL for the 'modifier' field. The description of the 'modifier' field is:

"The URL of the Sentinel User object that represents the last modifier of the object."

Returns:
The field's value in the bean instance, if any (may return null).
See Also:
MODIFIER

isModifierLinkNull

public boolean isModifierLinkNull()
Get whether the 'modifier' URL field has been set to Null or not. The description of the 'modifier' field is:

"The URL of the Sentinel User object that represents the last modifier of the object."

See the description of Null values.

Returns:
true if the field value has been marked as null, false otherwise.
See Also:
MODIFIER

isModifierLinkClear

public boolean isModifierLinkClear()
Get whether the value for the 'modifier' URL field is clear or not. The description of the 'modifier' field is:

"The URL of the Sentinel User object that represents the last modifier of the object."

See the description of cleared values.

Returns:
true if the field value has been cleared, false otherwise.
See Also:
MODIFIER

getCreatorLink

public String getCreatorLink()
Get the URL for the 'creator' field. The description of the 'creator' field is:

"The URL of the Sentinel User object that represents the creator of the object."

Returns:
The field's value in the bean instance, if any (may return null).
See Also:
CREATOR

isCreatorLinkNull

public boolean isCreatorLinkNull()
Get whether the 'creator' URL field has been set to Null or not. The description of the 'creator' field is:

"The URL of the Sentinel User object that represents the creator of the object."

See the description of Null values.

Returns:
true if the field value has been marked as null, false otherwise.
See Also:
CREATOR

isCreatorLinkClear

public boolean isCreatorLinkClear()
Get whether the value for the 'creator' URL field is clear or not. The description of the 'creator' field is:

"The URL of the Sentinel User object that represents the creator of the object."

See the description of cleared values.

Returns:
true if the field value has been cleared, false otherwise.
See Also:
CREATOR

getBeanMetaData

public static BeanMetaData<? extends CorrelatedEventsBean> getBeanMetaData()
Get the metadata class instance for this type.

The metadata is used primarily as a parameter to a BeanTransporter implementation''s constructor.


clone

public CorrelatedEventsBean clone()
Create a duplicate of this bean instance, including all field values.

Overrides:
clone in class Object