com.novell.db.object.bean
Class AnnotationBean

java.lang.Object
  com.novell.sentinel.client.bean.SentinelBean
      com.novell.db.object.bean.AnnotationBean

public class AnnotationBean
extends SentinelBean

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

The description of the type is:

"An Annotation object contains notes or actions added to an incident."

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	ACTION The "bean name" of the Sentinel data object field 'Action'.
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	MODIFIER The "bean name" of the Sentinel data object field 'Modifier'.
static String	TEXT The "bean name" of the Sentinel data object field 'Text'.

Constructor Summary

	AnnotationBean() Construct an instance of the bean class.
protected	AnnotationBean(BeanMetaData<? extends SentinelBean> metadata) Constructor for use by derived classes.

Method Summary

void	clearAction() Clear any current value for the 'action' field in the bean.
void	clearText() Clear any current value for the 'text' field in the bean.
AnnotationBean	clone() Create a duplicate of this bean instance, including all field values.
String	getAction() Get the value for the 'action' field.
static BeanMetaData<? extends AnnotationBean>	getBeanMetaData() Get the metadata class instance for this type.
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	getText() Get the value for the 'text' field.
boolean	isActionClear() Get whether the value for the 'action' field is clear or not.
boolean	isActionNull() Get whether the 'action' 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	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	isTextClear() Get whether the value for the 'text' field is clear or not.
boolean	isTextNull() Get whether the 'text' field has been set to Null or not.
void	setAction(String action) Set the value for the 'action' field.
void	setActionNull() Set to Null any current value for the 'action' field in the bean.
void	setText(String text) Set the value for the 'text' field.
void	setTextNull() Set to Null any current value for the 'text' 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

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

TEXT

public static final String TEXT

The "bean name" of the Sentinel data object field 'Text'. The value is ""text"".

The description of the 'text' field is:

"Text or data for the annotation."

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

ACTION

public static final String ACTION

The "bean name" of the Sentinel data object field 'Action'. The value is ""action"".

The description of the 'action' field is:

"The annotation action."

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

Constructor Detail

AnnotationBean

public AnnotationBean()

Construct an instance of the bean class.

AnnotationBean

protected AnnotationBean(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

getText

public String getText()

Get the value for the 'text' field. The description of the 'text' field is:

"Text or data for the annotation."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

TEXT

isTextNull

public boolean isTextNull()

Get whether the 'text' field has been set to Null or not. The description of the 'text' field is:

"Text or data for the annotation."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setTextNull(), TEXT

isTextClear

public boolean isTextClear()

Get whether the value for the 'text' field is clear or not. The description of the 'text' field is:

"Text or data for the annotation."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearText(), TEXT

setText

public void setText(String text)

Set the value for the 'text' field. The description of the 'text' field is:

"Text or data for the annotation."

Parameters:

text - Value to set

See Also:

TEXT

clearText

public void clearText()

Clear any current value for the 'text' field in the bean. The description of the 'text' field is:

"Text or data for the annotation."

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

See the description of cleared values.

See Also:

TEXT

setTextNull

public void setTextNull()

Set to Null any current value for the 'text' field in the bean. The description of the 'text' field is:

"Text or data for the annotation."

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

See the description of Null values.

See Also:

TEXT

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

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

getAction

public String getAction()

Get the value for the 'action' field. The description of the 'action' field is:

"The annotation action."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

ACTION

isActionNull

public boolean isActionNull()

Get whether the 'action' field has been set to Null or not. The description of the 'action' field is:

"The annotation action."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setActionNull(), ACTION

isActionClear

public boolean isActionClear()

Get whether the value for the 'action' field is clear or not. The description of the 'action' field is:

"The annotation action."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearAction(), ACTION

setAction

public void setAction(String action)

Set the value for the 'action' field. The description of the 'action' field is:

"The annotation action."

Parameters:

action - Value to set

See Also:

ACTION

clearAction

public void clearAction()

Clear any current value for the 'action' field in the bean. The description of the 'action' field is:

"The annotation action."

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

See the description of cleared values.

See Also:

ACTION

setActionNull

public void setActionNull()

Set to Null any current value for the 'action' field in the bean. The description of the 'action' field is:

"The annotation action."

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

See the description of Null values.

See Also:

ACTION

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 AnnotationBean> 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 AnnotationBean clone()

Create a duplicate of this bean instance, including all field values.

Overrides:

clone in class Object