com.novell.db.object.bean
Class DistSearchAuthBean

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

public class DistSearchAuthBean
extends SentinelBean

An automatically-generated "bean" class for the Sentinel data object type 'dist-search-auth'.

The description of the type is:

"null"

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	AUTHTOKEN The "bean name" of the Sentinel data object field 'AuthToken'.
static String	TARGET The "bean name" of the Sentinel data object field 'Target'.

Constructor Summary

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

Method Summary

void	clearAuthToken() Clear any current value for the 'auth-token' field in the bean.
void	clearTargetLink() Clear any current URL value for the 'target' field in the bean.
DistSearchAuthBean	clone() Create a duplicate of this bean instance, including all field values.
String	getAuthToken() Get the value for the 'auth-token' field.
static BeanMetaData<? extends DistSearchAuthBean>	getBeanMetaData() Get the metadata class instance for this type.
String	getTargetLink() Get the URL for the 'target' field.
boolean	isAuthTokenClear() Get whether the value for the 'auth-token' field is clear or not.
boolean	isAuthTokenNull() Get whether the 'auth-token' field has been set to Null or not.
boolean	isTargetLinkClear() Get whether the value for the 'target' URL field is clear or not.
boolean	isTargetLinkNull() Get whether the 'target' URL field has been set to Null or not.
void	setAuthToken(String authToken) Set the value for the 'auth-token' field.
void	setAuthTokenNull() Set to Null any current value for the 'auth-token' field in the bean.
void	setTargetLink(String target) Set a URL value for the 'target' field.
void	setTargetLinkNull() Set to Null any current URL value for the 'target' 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

AUTHTOKEN

public static final String AUTHTOKEN

The "bean name" of the Sentinel data object field 'AuthToken'. The value is ""auth-token"".

The description of the 'auth-token' field is:

"No description provided."

See Also:

Constant Field Values

TARGET

public static final String TARGET

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

The description of the 'target' field is:

"No description provided."

See Also:

Constant Field Values

Constructor Detail

DistSearchAuthBean

public DistSearchAuthBean()

Construct an instance of the bean class.

DistSearchAuthBean

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

getAuthToken

public String getAuthToken()

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

"No description provided."

Returns:

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

See Also:

AUTHTOKEN

isAuthTokenNull

public boolean isAuthTokenNull()

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

setAuthTokenNull(), AUTHTOKEN

isAuthTokenClear

public boolean isAuthTokenClear()

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

"No description provided."

See the description of cleared values.

Returns:

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

See Also:

clearAuthToken(), AUTHTOKEN

setAuthToken

public void setAuthToken(String authToken)

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

"No description provided."

Parameters:

authToken - Value to set

See Also:

AUTHTOKEN

clearAuthToken

public void clearAuthToken()

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

"No description provided."

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

See the description of cleared values.

See Also:

AUTHTOKEN

setAuthTokenNull

public void setAuthTokenNull()

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

"No description provided."

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

See the description of Null values.

See Also:

AUTHTOKEN

getTargetLink

public String getTargetLink()

Get the URL for the 'target' field. The description of the 'target' field is:

"No description provided."

Returns:

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

See Also:

TARGET

isTargetLinkNull

public boolean isTargetLinkNull()

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

setTargetLinkNull(), TARGET

isTargetLinkClear

public boolean isTargetLinkClear()

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

"No description provided."

See the description of cleared values.

Returns:

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

See Also:

clearTargetLink(), TARGET

setTargetLink

public void setTargetLink(String target)

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

"No description provided."

Parameters:

target - Value to set

See Also:

TARGET

clearTargetLink

public void clearTargetLink()

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

"No description provided."

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

See the description of cleared values.

See Also:

TARGET

setTargetLinkNull

public void setTargetLinkNull()

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

"No description provided."

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

See the description of Null values.

See Also:

TARGET

getBeanMetaData

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

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

Overrides:

clone in class Object