com.novell.db.object.bean
Class PortReferenceBean

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

public class PortReferenceBean
extends SentinelBean

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

The description of the type is:

"A port reference object representing a network port 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	PORT_DESCRIPTION The "bean name" of the Sentinel data object field 'PortDescription'.
static String	PORT_KEYWORD The "bean name" of the Sentinel data object field 'PortKeyword'.
static String	PORT_NUMBER The "bean name" of the Sentinel data object field 'PortNumber'.
static String	PROTOCOL_NUMBER The "bean name" of the Sentinel data object field 'ProtocolNumber'.
static String	REL_PROTOCOL_REF The "bean name" of the Sentinel data object field 'ProtocolReference'.

Constructor Summary

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

Method Summary

void	clearPortDescription() Clear any current value for the 'description' field in the bean.
void	clearPortKeyword() Clear any current value for the 'keyword' field in the bean.
void	clearPortNumber() Clear any current value for the 'port-number' field in the bean.
void	clearProtocolNumber() Clear any current value for the 'protocol-number' field in the bean.
void	clearProtocolReference() Clear any current value for the 'protocol-reference' field in the bean.
PortReferenceBean	clone() Create a duplicate of this bean instance, including all field values.
static BeanMetaData<? extends PortReferenceBean>	getBeanMetaData() Get the metadata class instance for this type.
String	getPortDescription() Get the value for the 'description' field.
String	getPortKeyword() Get the value for the 'keyword' field.
int	getPortNumber() Get the value for the 'port-number' field.
int	getProtocolNumber() Get the value for the 'protocol-number' field.
ProtocolReferenceBean	getProtocolReference() Get the value for the 'protocol-reference' field.
boolean	isPortDescriptionClear() Get whether the value for the 'description' field is clear or not.
boolean	isPortDescriptionNull() Get whether the 'description' field has been set to Null or not.
boolean	isPortKeywordClear() Get whether the value for the 'keyword' field is clear or not.
boolean	isPortKeywordNull() Get whether the 'keyword' field has been set to Null or not.
boolean	isPortNumberClear() Get whether the value for the 'port-number' field is clear or not.
boolean	isPortNumberNull() Get whether the 'port-number' field has been set to Null or not.
boolean	isProtocolNumberClear() Get whether the value for the 'protocol-number' field is clear or not.
boolean	isProtocolNumberNull() Get whether the 'protocol-number' field has been set to Null or not.
boolean	isProtocolReferenceClear() Get whether the value for the 'protocol-reference' field is clear or not.
boolean	isProtocolReferenceNull() Get whether the 'protocol-reference' field has been set to Null or not.
void	setPortDescription(String portDescription) Set the value for the 'description' field.
void	setPortDescriptionNull() Set to Null any current value for the 'description' field in the bean.
void	setPortKeyword(String portKeyword) Set the value for the 'keyword' field.
void	setPortKeywordNull() Set to Null any current value for the 'keyword' field in the bean.
void	setPortNumber(int portNumber) Set the value for the 'port-number' field.
void	setPortNumberNull() Set to Null any current value for the 'port-number' field in the bean.
void	setProtocolNumber(int protocolNumber) Set the value for the 'protocol-number' field.
void	setProtocolNumberNull() Set to Null any current value for the 'protocol-number' field in the bean.
void	setProtocolReference(ProtocolReferenceBean protocolReference) Set the value for the 'protocol-reference' field.
void	setProtocolReferenceNull() Set to Null any current value for the 'protocol-reference' 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 ""protocol-number"".

The description of the 'protocol-number' field is:

"No description provided."

See Also:

Constant Field Values

REL_PROTOCOL_REF

public static final String REL_PROTOCOL_REF

The "bean name" of the Sentinel data object field 'ProtocolReference'. The value is ""protocol-reference"".

The description of the 'protocol-reference' field is:

"Reference to a protocol object."

See Also:

Constant Field Values

PORT_KEYWORD

public static final String PORT_KEYWORD

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

The description of the 'keyword' field is:

"No description provided."

See Also:

Constant Field Values

PORT_DESCRIPTION

public static final String PORT_DESCRIPTION

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

The description of the 'description' field is:

"No description provided."

See Also:

Constant Field Values

PORT_NUMBER

public static final String PORT_NUMBER

The "bean name" of the Sentinel data object field 'PortNumber'. The value is ""port-number"".

The description of the 'port-number' field is:

"No description provided."

See Also:

Constant Field Values

Constructor Detail

PortReferenceBean

public PortReferenceBean()

Construct an instance of the bean class.

PortReferenceBean

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

getProtocolNumber

public int getProtocolNumber()

Get the value for the 'protocol-number' field. The description of the 'protocol-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 'protocol-number' field has been set to Null or not. The description of the 'protocol-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 'protocol-number' field is clear or not. The description of the 'protocol-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 'protocol-number' field. The description of the 'protocol-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 'protocol-number' field in the bean. The description of the 'protocol-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 'protocol-number' field in the bean. The description of the 'protocol-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

getPortDescription

public String getPortDescription()

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:

PORT_DESCRIPTION

isPortDescriptionNull

public boolean isPortDescriptionNull()

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:

setPortDescriptionNull(), PORT_DESCRIPTION

isPortDescriptionClear

public boolean isPortDescriptionClear()

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:

clearPortDescription(), PORT_DESCRIPTION

setPortDescription

public void setPortDescription(String portDescription)

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

"No description provided."

Parameters:

portDescription - Value to set

See Also:

PORT_DESCRIPTION

clearPortDescription

public void clearPortDescription()

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 setPortDescriptionNull() method to clear the server's value.

See the description of cleared values.

See Also:

PORT_DESCRIPTION

setPortDescriptionNull

public void setPortDescriptionNull()

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 clearPortDescription() method to avoid clearing the server's value.

See the description of Null values.

See Also:

PORT_DESCRIPTION

getPortKeyword

public String getPortKeyword()

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:

PORT_KEYWORD

isPortKeywordNull

public boolean isPortKeywordNull()

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:

setPortKeywordNull(), PORT_KEYWORD

isPortKeywordClear

public boolean isPortKeywordClear()

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:

clearPortKeyword(), PORT_KEYWORD

setPortKeyword

public void setPortKeyword(String portKeyword)

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

"No description provided."

Parameters:

portKeyword - Value to set

See Also:

PORT_KEYWORD

clearPortKeyword

public void clearPortKeyword()

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 setPortKeywordNull() method to clear the server's value.

See the description of cleared values.

See Also:

PORT_KEYWORD

setPortKeywordNull

public void setPortKeywordNull()

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 clearPortKeyword() method to avoid clearing the server's value.

See the description of Null values.

See Also:

PORT_KEYWORD

getPortNumber

public int getPortNumber()

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

"No description provided."

Returns:

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

See Also:

PORT_NUMBER

isPortNumberNull

public boolean isPortNumberNull()

Get whether the 'port-number' field has been set to Null or not. The description of the 'port-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:

setPortNumberNull(), PORT_NUMBER

isPortNumberClear

public boolean isPortNumberClear()

Get whether the value for the 'port-number' field is clear or not. The description of the 'port-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:

clearPortNumber(), PORT_NUMBER

setPortNumber

public void setPortNumber(int portNumber)

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

"No description provided."

Parameters:

portNumber - Value to set

See Also:

PORT_NUMBER

clearPortNumber

public void clearPortNumber()

Clear any current value for the 'port-number' field in the bean. The description of the 'port-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 setPortNumberNull() method to clear the server's value.

See the description of cleared values.

See Also:

PORT_NUMBER

setPortNumberNull

public void setPortNumberNull()

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

"No description provided."

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

See the description of Null values.

See Also:

PORT_NUMBER

getProtocolReference

public ProtocolReferenceBean getProtocolReference()

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

"Reference to a protocol object."

Returns:

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

See Also:

REL_PROTOCOL_REF

isProtocolReferenceNull

public boolean isProtocolReferenceNull()

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

"Reference to a protocol object."

See the description of Null values.

Returns:

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

See Also:

setProtocolReferenceNull(), REL_PROTOCOL_REF

isProtocolReferenceClear

public boolean isProtocolReferenceClear()

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

"Reference to a protocol object."

See the description of cleared values.

Returns:

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

See Also:

clearProtocolReference(), REL_PROTOCOL_REF

setProtocolReference

public void setProtocolReference(ProtocolReferenceBean protocolReference)

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

"Reference to a protocol object."

Parameters:

protocolReference - Value to set

See Also:

REL_PROTOCOL_REF

clearProtocolReference

public void clearProtocolReference()

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

"Reference to a protocol object."

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

See the description of cleared values.

See Also:

REL_PROTOCOL_REF

setProtocolReferenceNull

public void setProtocolReferenceNull()

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

"Reference to a protocol object."

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

See the description of Null values.

See Also:

REL_PROTOCOL_REF

getBeanMetaData

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

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

Overrides:

clone in class Object