com.novell.db.object.bean
Class IncidentCategoryBean

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

public class IncidentCategoryBean
extends SentinelBean

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

The description of the type is:

"A classification or grouping for 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	DESCRIPTION The "bean name" of the Sentinel data object field 'description'.
static String	NAME The "bean name" of the Sentinel data object field 'name'.

Constructor Summary

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

Method Summary

void	clearDescription() Clear any current value for the 'desc' field in the bean.
void	clearName() Clear any current value for the 'name' field in the bean.
IncidentCategoryBean	clone() Create a duplicate of this bean instance, including all field values.
static BeanMetaData<? extends IncidentCategoryBean>	getBeanMetaData() Get the metadata class instance for this type.
String	getDescription() Get the value for the 'desc' field.
String	getName() Get the value for the 'name' field.
boolean	isDescriptionClear() Get whether the value for the 'desc' field is clear or not.
boolean	isDescriptionNull() Get whether the 'desc' field has been set to Null or not.
boolean	isNameClear() Get whether the value for the 'name' field is clear or not.
boolean	isNameNull() Get whether the 'name' field has been set to Null or not.
void	setDescription(String description) Set the value for the 'desc' field.
void	setDescriptionNull() Set to Null any current value for the 'desc' field in the bean.
void	setName(String name) Set the value for the 'name' field.
void	setNameNull() Set to Null any current value for the 'name' 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

NAME

public static final String NAME

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

The description of the 'name' field is:

"The incident category name."

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

The "bean name" of the Sentinel data object field 'description'. The value is ""desc"".

The description of the 'desc' field is:

"The description of the incident category."

See Also:

Constant Field Values

Constructor Detail

IncidentCategoryBean

public IncidentCategoryBean()

Construct an instance of the bean class.

IncidentCategoryBean

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

getDescription

public String getDescription()

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

"The description of the incident category."

Returns:

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

See Also:

DESCRIPTION

isDescriptionNull

public boolean isDescriptionNull()

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

"The description of the incident category."

See the description of Null values.

Returns:

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

See Also:

setDescriptionNull(), DESCRIPTION

isDescriptionClear

public boolean isDescriptionClear()

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

"The description of the incident category."

See the description of cleared values.

Returns:

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

See Also:

clearDescription(), DESCRIPTION

setDescription

public void setDescription(String description)

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

"The description of the incident category."

Parameters:

description - Value to set

See Also:

DESCRIPTION

clearDescription

public void clearDescription()

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

"The description of the incident category."

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

See the description of cleared values.

See Also:

DESCRIPTION

setDescriptionNull

public void setDescriptionNull()

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

"The description of the incident category."

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

See the description of Null values.

See Also:

DESCRIPTION

getName

public String getName()

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

"The incident category name."

Returns:

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

See Also:

NAME

isNameNull

public boolean isNameNull()

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

"The incident category name."

See the description of Null values.

Returns:

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

See Also:

setNameNull(), NAME

isNameClear

public boolean isNameClear()

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

"The incident category name."

See the description of cleared values.

Returns:

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

See Also:

clearName(), NAME

setName

public void setName(String name)

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

"The incident category name."

Parameters:

name - Value to set

See Also:

NAME

clearName

public void clearName()

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

"The incident category name."

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

See the description of cleared values.

See Also:

NAME

setNameNull

public void setNameNull()

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

"The incident category name."

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

See the description of Null values.

See Also:

NAME

getBeanMetaData

public static BeanMetaData<? extends IncidentCategoryBean> 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 IncidentCategoryBean clone()

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

Overrides:

clone in class Object