com.novell.db.object.bean
Class PermissionBean

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

public class PermissionBean
extends SentinelBean

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

The description of the type is:

"A Permission object contains the definition of a named privilege that can be assigned to a user account (via a UserGroup, or Role) in the Sentinel system."

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	PermissionBean.PermCategoryType An enumerated type representing values for the field 'category'.
static class	PermissionBean.PermTypeType An enumerated type representing values for the field 'type'.

Field Summary

static String	CREATOR The "bean name" of the Sentinel data object field 'Creator'.
static String	DATE_CREATED The "bean name" of the Sentinel data object field 'DateCreated'.
static String	DATE_MODIFIED The "bean name" of the Sentinel data object field 'DateModified'.
static String	MODIFIER The "bean name" of the Sentinel data object field 'Modifier'.
static String	PERM_CATEGORY The "bean name" of the Sentinel data object field 'PermCategory'.
static String	PERM_DESC The "bean name" of the Sentinel data object field 'PermDesc'.
static String	PERM_NAME The "bean name" of the Sentinel data object field 'PermName'.
static String	PERM_TYPE The "bean name" of the Sentinel data object field 'PermType'.

Constructor Summary

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

Method Summary

void	clearPermCategory() Clear any current value for the 'category' field in the bean.
void	clearPermDesc() Clear any current value for the 'desc' field in the bean.
void	clearPermName() Clear any current value for the 'name' field in the bean.
void	clearPermType() Clear any current value for the 'type' field in the bean.
PermissionBean	clone() Create a duplicate of this bean instance, including all field values.
static BeanMetaData<? extends PermissionBean>	getBeanMetaData() Get the metadata class instance for this type.
String	getCreatorLink() Get the URL for the 'creator' field.
Date	getDateCreated() Get the value for the 'createdate' field.
Date	getDateModified() Get the value for the 'moddate' field.
String	getModifierLink() Get the URL for the 'modifier' field.
PermissionBean.PermCategoryType	getPermCategory() Get the value for the 'category' field.
String	getPermDesc() Get the value for the 'desc' field.
String	getPermName() Get the value for the 'name' field.
PermissionBean.PermTypeType	getPermType() Get the value for the 'type' field.
boolean	isCreatorLinkClear() Get whether the value for the 'creator' URL field is clear or not.
boolean	isCreatorLinkNull() Get whether the 'creator' URL field has been set to Null or not.
boolean	isDateCreatedClear() Get whether the value for the 'createdate' field is clear or not.
boolean	isDateCreatedNull() Get whether the 'createdate' field has been set to Null or not.
boolean	isDateModifiedClear() Get whether the value for the 'moddate' field is clear or not.
boolean	isDateModifiedNull() Get whether the 'moddate' field has been set to Null or not.
boolean	isModifierLinkClear() Get whether the value for the 'modifier' URL field is clear or not.
boolean	isModifierLinkNull() Get whether the 'modifier' URL field has been set to Null or not.
boolean	isPermCategoryClear() Get whether the value for the 'category' field is clear or not.
boolean	isPermCategoryNull() Get whether the 'category' field has been set to Null or not.
boolean	isPermDescClear() Get whether the value for the 'desc' field is clear or not.
boolean	isPermDescNull() Get whether the 'desc' 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	isPermTypeClear() Get whether the value for the 'type' field is clear or not.
boolean	isPermTypeNull() Get whether the 'type' field has been set to Null or not.
void	setPermCategory(PermissionBean.PermCategoryType permCategory) Set the value for the 'category' field.
void	setPermCategoryNull() Set to Null any current value for the 'category' field in the bean.
void	setPermDesc(String permDesc) Set the value for the 'desc' field.
void	setPermDescNull() Set to Null any current value for the 'desc' 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	setPermType(PermissionBean.PermTypeType permType) Set the value for the 'type' field.
void	setPermTypeNull() Set to Null any current value for the 'type' 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

DATE_MODIFIED

public static final String DATE_MODIFIED

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

The description of the 'moddate' field is:

"The date and time when the object was last modified."

See Also:

Constant Field Values

CREATOR

public static final String CREATOR

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

The description of the 'creator' field is:

"The URL of the Sentinel User object that represents the creator of the object."

See Also:

Constant Field Values

PERM_TYPE

public static final String PERM_TYPE

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

The description of the 'type' field is:

"The type of permission. Currently only "boolean" is supported, which grants or denies the permission."

See Also:

Constant Field Values

PERM_CATEGORY

public static final String PERM_CATEGORY

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

The description of the 'category' field is:

"The category to which the permission belongs. Permission categories group permissions for internal management purposes. The value is one of "viewAll", "viewFiltered", "incidents", "misc"."

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 internal name of the permission. This is typically not what is displayed in the Sentinel user interface."

See Also:

Constant Field Values

PERM_DESC

public static final String PERM_DESC

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

The description of the 'desc' field is:

"A human-readable description of the permission's purpose."

See Also:

Constant Field Values

MODIFIER

public static final String MODIFIER

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

The description of the 'modifier' field is:

"The URL of the Sentinel User object that represents the last modifier of the object."

See Also:

Constant Field Values

DATE_CREATED

public static final String DATE_CREATED

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

The description of the 'createdate' field is:

"The date and time when the object was created."

See Also:

Constant Field Values

Constructor Detail

PermissionBean

public PermissionBean()

Construct an instance of the bean class.

PermissionBean

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

getPermCategory

public PermissionBean.PermCategoryType getPermCategory()

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

"The category to which the permission belongs. Permission categories group permissions for internal management purposes. The value is one of "viewAll", "viewFiltered", "incidents", "misc"."

Returns:

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

See Also:

PERM_CATEGORY

isPermCategoryNull

public boolean isPermCategoryNull()

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

"The category to which the permission belongs. Permission categories group permissions for internal management purposes. The value is one of "viewAll", "viewFiltered", "incidents", "misc"."

See the description of Null values.

Returns:

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

See Also:

setPermCategoryNull(), PERM_CATEGORY

isPermCategoryClear

public boolean isPermCategoryClear()

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

"The category to which the permission belongs. Permission categories group permissions for internal management purposes. The value is one of "viewAll", "viewFiltered", "incidents", "misc"."

See the description of cleared values.

Returns:

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

See Also:

clearPermCategory(), PERM_CATEGORY

setPermCategory

public void setPermCategory(PermissionBean.PermCategoryType permCategory)

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

"The category to which the permission belongs. Permission categories group permissions for internal management purposes. The value is one of "viewAll", "viewFiltered", "incidents", "misc"."

Parameters:

permCategory - Value to set

See Also:

PERM_CATEGORY

clearPermCategory

public void clearPermCategory()

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

"The category to which the permission belongs. Permission categories group permissions for internal management purposes. The value is one of "viewAll", "viewFiltered", "incidents", "misc"."

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

See the description of cleared values.

See Also:

PERM_CATEGORY

setPermCategoryNull

public void setPermCategoryNull()

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

"The category to which the permission belongs. Permission categories group permissions for internal management purposes. The value is one of "viewAll", "viewFiltered", "incidents", "misc"."

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

See the description of Null values.

See Also:

PERM_CATEGORY

getDateModified

public Date getDateModified()

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

"The date and time when the object was last modified."

Returns:

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

See Also:

DATE_MODIFIED

isDateModifiedNull

public boolean isDateModifiedNull()

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

"The date and time when the object was last modified."

See the description of Null values.

Returns:

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

See Also:

DATE_MODIFIED

isDateModifiedClear

public boolean isDateModifiedClear()

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

"The date and time when the object was last modified."

See the description of cleared values.

Returns:

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

See Also:

DATE_MODIFIED

getPermDesc

public String getPermDesc()

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

"A human-readable description of the permission's purpose."

Returns:

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

See Also:

PERM_DESC

isPermDescNull

public boolean isPermDescNull()

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

"A human-readable description of the permission's purpose."

See the description of Null values.

Returns:

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

See Also:

setPermDescNull(), PERM_DESC

isPermDescClear

public boolean isPermDescClear()

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

"A human-readable description of the permission's purpose."

See the description of cleared values.

Returns:

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

See Also:

clearPermDesc(), PERM_DESC

setPermDesc

public void setPermDesc(String permDesc)

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

"A human-readable description of the permission's purpose."

Parameters:

permDesc - Value to set

See Also:

PERM_DESC

clearPermDesc

public void clearPermDesc()

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

"A human-readable description of the permission's purpose."

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

See the description of cleared values.

See Also:

PERM_DESC

setPermDescNull

public void setPermDescNull()

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

"A human-readable description of the permission's purpose."

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

See the description of Null values.

See Also:

PERM_DESC

getPermName

public String getPermName()

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

"The internal name of the permission. This is typically not what is displayed in the Sentinel user interface."

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 internal name of the permission. This is typically not what is displayed in the Sentinel user interface."

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 internal name of the permission. This is typically not what is displayed in the Sentinel user interface."

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 internal name of the permission. This is typically not what is displayed in the Sentinel user interface."

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 internal name of the permission. This is typically not what is displayed in the Sentinel user interface."

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 internal name of the permission. This is typically not what is displayed in the Sentinel user interface."

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

getDateCreated

public Date getDateCreated()

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

"The date and time when the object was created."

Returns:

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

See Also:

DATE_CREATED

isDateCreatedNull

public boolean isDateCreatedNull()

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

"The date and time when the object was created."

See the description of Null values.

Returns:

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

See Also:

DATE_CREATED

isDateCreatedClear

public boolean isDateCreatedClear()

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

"The date and time when the object was created."

See the description of cleared values.

Returns:

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

See Also:

DATE_CREATED

getPermType

public PermissionBean.PermTypeType getPermType()

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

"The type of permission. Currently only "boolean" is supported, which grants or denies the permission."

Returns:

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

See Also:

PERM_TYPE

isPermTypeNull

public boolean isPermTypeNull()

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

"The type of permission. Currently only "boolean" is supported, which grants or denies the permission."

See the description of Null values.

Returns:

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

See Also:

setPermTypeNull(), PERM_TYPE

isPermTypeClear

public boolean isPermTypeClear()

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

"The type of permission. Currently only "boolean" is supported, which grants or denies the permission."

See the description of cleared values.

Returns:

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

See Also:

clearPermType(), PERM_TYPE

setPermType

public void setPermType(PermissionBean.PermTypeType permType)

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

"The type of permission. Currently only "boolean" is supported, which grants or denies the permission."

Parameters:

permType - Value to set

See Also:

PERM_TYPE

clearPermType

public void clearPermType()

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

"The type of permission. Currently only "boolean" is supported, which grants or denies the permission."

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

See the description of cleared values.

See Also:

PERM_TYPE

setPermTypeNull

public void setPermTypeNull()

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

"The type of permission. Currently only "boolean" is supported, which grants or denies the permission."

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

See the description of Null values.

See Also:

PERM_TYPE

getModifierLink

public String getModifierLink()

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

"The URL of the Sentinel User object that represents the last modifier of the object."

Returns:

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

See Also:

MODIFIER

isModifierLinkNull

public boolean isModifierLinkNull()

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

"The URL of the Sentinel User object that represents the last modifier of the object."

See the description of Null values.

Returns:

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

See Also:

MODIFIER

isModifierLinkClear

public boolean isModifierLinkClear()

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

"The URL of the Sentinel User object that represents the last modifier of the object."

See the description of cleared values.

Returns:

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

See Also:

MODIFIER

getCreatorLink

public String getCreatorLink()

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

"The URL of the Sentinel User object that represents the creator of the object."

Returns:

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

See Also:

CREATOR

isCreatorLinkNull

public boolean isCreatorLinkNull()

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

"The URL of the Sentinel User object that represents the creator of the object."

See the description of Null values.

Returns:

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

See Also:

CREATOR

isCreatorLinkClear

public boolean isCreatorLinkClear()

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

"The URL of the Sentinel User object that represents the creator of the object."

See the description of cleared values.

Returns:

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

See Also:

CREATOR

getBeanMetaData

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

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

Overrides:

clone in class Object