com.novell.db.object.bean
Class ProtocolReferenceBean

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

public class ProtocolReferenceBean
extends SentinelBean

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

The description of the type is:

"A protocol reference object representing a network protocol number and description."

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	PROTOCOL_DESCRIPTION The "bean name" of the Sentinel data object field 'ProtocolDescription'.
static String	PROTOCOL_KEYWORD The "bean name" of the Sentinel data object field 'ProtocolKeyword'.
static String	PROTOCOL_NUMBER The "bean name" of the Sentinel data object field 'ProtocolNumber'.

Constructor Summary

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

Method Summary

void	clearProtocolDescription() Clear any current value for the 'description' field in the bean.
void	clearProtocolKeyword() Clear any current value for the 'keyword' field in the bean.
void	clearProtocolNumber() Clear any current value for the 'number' field in the bean.
ProtocolReferenceBean	clone() Create a duplicate of this bean instance, including all field values.
static BeanMetaData<? extends ProtocolReferenceBean>	getBeanMetaData() Get the metadata class instance for this type.
String	getProtocolDescription() Get the value for the 'description' field.
String	getProtocolKeyword() Get the value for the 'keyword' field.
int	getProtocolNumber() Get the value for the 'number' field.
boolean	isProtocolDescriptionClear() Get whether the value for the 'description' field is clear or not.
boolean	isProtocolDescriptionNull() Get whether the 'description' field has been set to Null or not.
boolean	isProtocolKeywordClear() Get whether the value for the 'keyword' field is clear or not.
boolean	isProtocolKeywordNull() Get whether the 'keyword' field has been set to Null or not.
boolean	isProtocolNumberClear() Get whether the value for the 'number' field is clear or not.
boolean	isProtocolNumberNull() Get whether the 'number' field has been set to Null or not.
void	setProtocolDescription(String protocolDescription) Set the value for the 'description' field.
void	setProtocolDescriptionNull() Set to Null any current value for the 'description' field in the bean.
void	setProtocolKeyword(String protocolKeyword) Set the value for the 'keyword' field.
void	setProtocolKeywordNull() Set to Null any current value for the 'keyword' field in the bean.
void	setProtocolNumber(int protocolNumber) Set the value for the 'number' field.
void	setProtocolNumberNull() Set to Null any current value for the 'number' 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

PROTOCOL_NUMBER

public static final String PROTOCOL_NUMBER

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

The description of the 'number' field is:

"No description provided."

See Also:

Constant Field Values

PROTOCOL_KEYWORD

public static final String PROTOCOL_KEYWORD

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

The description of the 'keyword' field is:

"No description provided."

See Also:

Constant Field Values

PROTOCOL_DESCRIPTION

public static final String PROTOCOL_DESCRIPTION

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

The description of the 'description' field is:

"No description provided."

See Also:

Constant Field Values

Constructor Detail

ProtocolReferenceBean

public ProtocolReferenceBean()

Construct an instance of the bean class.

ProtocolReferenceBean

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

getProtocolDescription

public String getProtocolDescription()

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

"No description provided."

Returns:

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

See Also:

PROTOCOL_DESCRIPTION

isProtocolDescriptionNull

public boolean isProtocolDescriptionNull()

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

"No description provided."

See the description of Null values.

Returns:

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

See Also:

setProtocolDescriptionNull(), PROTOCOL_DESCRIPTION

isProtocolDescriptionClear

public boolean isProtocolDescriptionClear()

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

"No description provided."

See the description of cleared values.

Returns:

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

See Also:

clearProtocolDescription(), PROTOCOL_DESCRIPTION

setProtocolDescription

public void setProtocolDescription(String protocolDescription)

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

"No description provided."

Parameters:

protocolDescription - Value to set

See Also:

PROTOCOL_DESCRIPTION

clearProtocolDescription

public void clearProtocolDescription()

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

"No description provided."

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

See the description of cleared values.

See Also:

PROTOCOL_DESCRIPTION

setProtocolDescriptionNull

public void setProtocolDescriptionNull()

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

"No description provided."

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

See the description of Null values.

See Also:

PROTOCOL_DESCRIPTION

getProtocolKeyword

public String getProtocolKeyword()

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

"No description provided."

Returns:

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

See Also:

PROTOCOL_KEYWORD

isProtocolKeywordNull

public boolean isProtocolKeywordNull()

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

"No description provided."

See the description of Null values.

Returns:

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

See Also:

setProtocolKeywordNull(), PROTOCOL_KEYWORD

isProtocolKeywordClear

public boolean isProtocolKeywordClear()

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

"No description provided."

See the description of cleared values.

Returns:

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

See Also:

clearProtocolKeyword(), PROTOCOL_KEYWORD

setProtocolKeyword

public void setProtocolKeyword(String protocolKeyword)

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

"No description provided."

Parameters:

protocolKeyword - Value to set

See Also:

PROTOCOL_KEYWORD

clearProtocolKeyword

public void clearProtocolKeyword()

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

"No description provided."

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

See the description of cleared values.

See Also:

PROTOCOL_KEYWORD

setProtocolKeywordNull

public void setProtocolKeywordNull()

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

"No description provided."

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

See the description of Null values.

See Also:

PROTOCOL_KEYWORD

getProtocolNumber

public int getProtocolNumber()

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

"No description provided."

Returns:

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

See Also:

PROTOCOL_NUMBER

isProtocolNumberNull

public boolean isProtocolNumberNull()

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

"No description provided."

See the description of Null values.

Returns:

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

See Also:

setProtocolNumberNull(), PROTOCOL_NUMBER

isProtocolNumberClear

public boolean isProtocolNumberClear()

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

"No description provided."

See the description of cleared values.

Returns:

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

See Also:

clearProtocolNumber(), PROTOCOL_NUMBER

setProtocolNumber

public void setProtocolNumber(int protocolNumber)

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

"No description provided."

Parameters:

protocolNumber - Value to set

See Also:

PROTOCOL_NUMBER

clearProtocolNumber

public void clearProtocolNumber()

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

"No description provided."

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

See the description of cleared values.

See Also:

PROTOCOL_NUMBER

setProtocolNumberNull

public void setProtocolNumberNull()

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

"No description provided."

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

See the description of Null values.

See Also:

PROTOCOL_NUMBER

getBeanMetaData

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

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

Overrides:

clone in class Object