com.novell.db.object.bean
Class UserGroupPermissionBean

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

public class UserGroupPermissionBean
extends SentinelBean

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

The description of the type is:

"A UserGroupPermission object associates a Permission with a UserGroup and defines whether the UserGroup grants or denies the privilege associated with the Permission."

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

Nested Class Summary

static class

UserGroupPermissionBean.ValueType An enumerated type representing values for the field 'value'.

Field Summary

static String	PERM_NAME The "bean name" of the Sentinel data object field 'PermName'.
static String	PERM_VALUE The "bean name" of the Sentinel data object field 'Value'.
static String	PERMISSIONDEFINITION The "bean name" of the Sentinel data object field 'PermissionDefinition'.

Constructor Summary

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

Method Summary

void	clearPermissionDefinitionLink() Clear any current URL value for the 'def' field in the bean.
void	clearPermName() Clear any current value for the 'name' field in the bean.
void	clearValue() Clear any current value for the 'value' field in the bean.
UserGroupPermissionBean	clone() Create a duplicate of this bean instance, including all field values.
static BeanMetaData<? extends UserGroupPermissionBean>	getBeanMetaData() Get the metadata class instance for this type.
String	getPermissionDefinitionLink() Get the URL for the 'def' field.
String	getPermName() Get the value for the 'name' field.
UserGroupPermissionBean.ValueType	getValue() Get the value for the 'value' field.
boolean	isPermissionDefinitionLinkClear() Get whether the value for the 'def' URL field is clear or not.
boolean	isPermissionDefinitionLinkNull() Get whether the 'def' URL field has been set to Null or not.
boolean	isPermNameClear() Get whether the value for the 'name' field is clear or not.
boolean	isPermNameNull() Get whether the 'name' field has been set to Null or not.
boolean	isValueClear() Get whether the value for the 'value' field is clear or not.
boolean	isValueNull() Get whether the 'value' field has been set to Null or not.
void	setPermissionDefinitionLink(String permissionDefinition) Set a URL value for the 'def' field.
void	setPermissionDefinitionLinkNull() Set to Null any current URL value for the 'def' field in the bean.
void	setPermName(String permName) Set the value for the 'name' field.
void	setPermNameNull() Set to Null any current value for the 'name' field in the bean.
void	setValue(UserGroupPermissionBean.ValueType value) Set the value for the 'value' field.
void	setValueNull() Set to Null any current value for the 'value' 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

PERMISSIONDEFINITION

public static final String PERMISSIONDEFINITION

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

The description of the 'def' field is:

"The URL of the Permission object that is associated with the UserGroup by the UserGroupPermission object."

See Also:

Constant Field Values

PERM_VALUE

public static final String PERM_VALUE

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

The description of the 'value' field is:

"The value assigned to the UserGroup-Permission relationship. Currently only "true" and "false" are supported, and imply "GRANT" and "DENY", respectively."

See Also:

Constant Field Values

PERM_NAME

public static final String PERM_NAME

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

The description of the 'name' field is:

"The name of the Permission object associated with the UserGroup object."

See Also:

Constant Field Values

Constructor Detail

UserGroupPermissionBean

public UserGroupPermissionBean()

Construct an instance of the bean class.

UserGroupPermissionBean

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

getPermName

public String getPermName()

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

"The name of the Permission object associated with the UserGroup object."

Returns:

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

See Also:

PERM_NAME

isPermNameNull

public boolean isPermNameNull()

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

"The name of the Permission object associated with the UserGroup object."

See the description of Null values.

Returns:

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

See Also:

setPermNameNull(), PERM_NAME

isPermNameClear

public boolean isPermNameClear()

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

"The name of the Permission object associated with the UserGroup object."

See the description of cleared values.

Returns:

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

See Also:

clearPermName(), PERM_NAME

setPermName

public void setPermName(String permName)

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

"The name of the Permission object associated with the UserGroup object."

Parameters:

permName - Value to set

See Also:

PERM_NAME

clearPermName

public void clearPermName()

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

"The name of the Permission object associated with the UserGroup object."

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

See the description of cleared values.

See Also:

PERM_NAME

setPermNameNull

public void setPermNameNull()

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

"The name of the Permission object associated with the UserGroup object."

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

See the description of Null values.

See Also:

PERM_NAME

getValue

public UserGroupPermissionBean.ValueType getValue()

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

"The value assigned to the UserGroup-Permission relationship. Currently only "true" and "false" are supported, and imply "GRANT" and "DENY", respectively."

Returns:

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

See Also:

PERM_VALUE

isValueNull

public boolean isValueNull()

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

"The value assigned to the UserGroup-Permission relationship. Currently only "true" and "false" are supported, and imply "GRANT" and "DENY", respectively."

See the description of Null values.

Returns:

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

See Also:

setValueNull(), PERM_VALUE

isValueClear

public boolean isValueClear()

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

"The value assigned to the UserGroup-Permission relationship. Currently only "true" and "false" are supported, and imply "GRANT" and "DENY", respectively."

See the description of cleared values.

Returns:

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

See Also:

clearValue(), PERM_VALUE

setValue

public void setValue(UserGroupPermissionBean.ValueType value)

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

"The value assigned to the UserGroup-Permission relationship. Currently only "true" and "false" are supported, and imply "GRANT" and "DENY", respectively."

Parameters:

value - Value to set

See Also:

PERM_VALUE

clearValue

public void clearValue()

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

"The value assigned to the UserGroup-Permission relationship. Currently only "true" and "false" are supported, and imply "GRANT" and "DENY", respectively."

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

See the description of cleared values.

See Also:

PERM_VALUE

setValueNull

public void setValueNull()

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

"The value assigned to the UserGroup-Permission relationship. Currently only "true" and "false" are supported, and imply "GRANT" and "DENY", respectively."

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

See the description of Null values.

See Also:

PERM_VALUE

getPermissionDefinitionLink

public String getPermissionDefinitionLink()

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

"The URL of the Permission object that is associated with the UserGroup by the UserGroupPermission object."

Returns:

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

See Also:

PERMISSIONDEFINITION

isPermissionDefinitionLinkNull

public boolean isPermissionDefinitionLinkNull()

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

"The URL of the Permission object that is associated with the UserGroup by the UserGroupPermission object."

See the description of Null values.

Returns:

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

See Also:

setPermissionDefinitionLinkNull(), PERMISSIONDEFINITION

isPermissionDefinitionLinkClear

public boolean isPermissionDefinitionLinkClear()

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

"The URL of the Permission object that is associated with the UserGroup by the UserGroupPermission object."

See the description of cleared values.

Returns:

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

See Also:

clearPermissionDefinitionLink(), PERMISSIONDEFINITION

setPermissionDefinitionLink

public void setPermissionDefinitionLink(String permissionDefinition)

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

"The URL of the Permission object that is associated with the UserGroup by the UserGroupPermission object."

Parameters:

permissionDefinition - Value to set

See Also:

PERMISSIONDEFINITION

clearPermissionDefinitionLink

public void clearPermissionDefinitionLink()

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

"The URL of the Permission object that is associated with the UserGroup by the UserGroupPermission object."

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

See the description of cleared values.

See Also:

PERMISSIONDEFINITION

setPermissionDefinitionLinkNull

public void setPermissionDefinitionLinkNull()

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

"The URL of the Permission object that is associated with the UserGroup by the UserGroupPermission object."

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

See the description of Null values.

See Also:

PERMISSIONDEFINITION

getBeanMetaData

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

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

Overrides:

clone in class Object