com.novell.db.object.bean
Class UserPermissionsBean

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

public class UserPermissionsBean
extends SentinelBean

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

The description of the type is:

"The UserPermissions object contains the current permissions for a user 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

Field Summary

static String	ADMIN The "bean name" of the Sentinel data object field 'Admin'.
static String	ALLOWALLEVENTS The "bean name" of the Sentinel data object field 'AllowAllEvents'.
static String	CANCHANGEOWNPASSWORD The "bean name" of the Sentinel data object field 'CanChangeOwnPassword'.
static String	EFFECTIVEPERMISSIONS The "bean name" of the Sentinel data object field 'EffectivePermissions'.
static String	EVENTFILTER The "bean name" of the Sentinel data object field 'EventFilter'.

Constructor Summary

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

Method Summary

void	addToEffectivePermissions(String value) Add a value to the collection field 'perm-set'.
void	clearAdmin() Clear any current value for the 'isadmin' field in the bean.
void	clearAllowAllEvents() Clear any current value for the 'all-events' field in the bean.
void	clearCanChangeOwnPassword() Clear any current value for the 'chg-pwd' field in the bean.
void	clearEffectivePermissions() Clear any current value for the 'perm-set' field in the bean.
void	clearEventFilter() Clear any current value for the 'filter' field in the bean.
UserPermissionsBean	clone() Create a duplicate of this bean instance, including all field values.
static BeanMetaData<? extends UserPermissionsBean>	getBeanMetaData() Get the metadata class instance for this type.
Collection<String>	getEffectivePermissions() Get the value for the 'perm-set' field.
String	getEventFilter() Get the value for the 'filter' field.
boolean	isAdmin() Get the value for the 'isadmin' field.
boolean	isAdminClear() Get whether the value for the 'isadmin' field is clear or not.
boolean	isAdminNull() Get whether the 'isadmin' field has been set to Null or not.
boolean	isAllowAllEvents() Get the value for the 'all-events' field.
boolean	isAllowAllEventsClear() Get whether the value for the 'all-events' field is clear or not.
boolean	isAllowAllEventsNull() Get whether the 'all-events' field has been set to Null or not.
boolean	isCanChangeOwnPassword() Get the value for the 'chg-pwd' field.
boolean	isCanChangeOwnPasswordClear() Get whether the value for the 'chg-pwd' field is clear or not.
boolean	isCanChangeOwnPasswordNull() Get whether the 'chg-pwd' field has been set to Null or not.
boolean	isEffectivePermissionsClear() Get whether the value for the 'perm-set' field is clear or not.
boolean	isEffectivePermissionsNull() Get whether the 'perm-set' field has been set to Null or not.
boolean	isEventFilterClear() Get whether the value for the 'filter' field is clear or not.
boolean	isEventFilterNull() Get whether the 'filter' field has been set to Null or not.
void	setAdmin(boolean admin) Set the value for the 'isadmin' field.
void	setAdminNull() Set to Null any current value for the 'isadmin' field in the bean.
void	setAllowAllEvents(boolean allowAllEvents) Set the value for the 'all-events' field.
void	setAllowAllEventsNull() Set to Null any current value for the 'all-events' field in the bean.
void	setCanChangeOwnPassword(boolean canChangeOwnPassword) Set the value for the 'chg-pwd' field.
void	setCanChangeOwnPasswordNull() Set to Null any current value for the 'chg-pwd' field in the bean.
void	setEffectivePermissions(Collection<? extends String> effectivePermissions) Set the value for the 'perm-set' field.
void	setEffectivePermissionsNull() Set to Null any current value for the 'perm-set' field in the bean.
void	setEventFilter(String eventFilter) Set the value for the 'filter' field.
void	setEventFilterNull() Set to Null any current value for the 'filter' 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

ADMIN

public static final String ADMIN

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

The description of the 'isadmin' field is:

"If true, the user has administrator privileges."

See Also:

Constant Field Values

ALLOWALLEVENTS

public static final String ALLOWALLEVENTS

The "bean name" of the Sentinel data object field 'AllowAllEvents'. The value is ""all-events"".

The description of the 'all-events' field is:

"If true, the user can view all event records in the Sentinel system. If false, the filter value is used to determine the set of events the user is allowed to view."

See Also:

Constant Field Values

CANCHANGEOWNPASSWORD

public static final String CANCHANGEOWNPASSWORD

The "bean name" of the Sentinel data object field 'CanChangeOwnPassword'. The value is ""chg-pwd"".

The description of the 'chg-pwd' field is:

"If true, a user can change his own password."

See Also:

Constant Field Values

EVENTFILTER

public static final String EVENTFILTER

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

The description of the 'filter' field is:

"If non-empty, and AllowAllEvents is false, this value is a filter expression that determines the set of events the user is allowed to view."

See Also:

Constant Field Values

EFFECTIVEPERMISSIONS

public static final String EFFECTIVEPERMISSIONS

The "bean name" of the Sentinel data object field 'EffectivePermissions'. The value is ""perm-set"".

The description of the 'perm-set' field is:

"This collection contains the calculated set of permissions effective for the user based on the user's role memberships."

See Also:

Constant Field Values

Constructor Detail

UserPermissionsBean

public UserPermissionsBean()

Construct an instance of the bean class.

UserPermissionsBean

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

isAllowAllEvents

public boolean isAllowAllEvents()

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

"If true, the user can view all event records in the Sentinel system. If false, the filter value is used to determine the set of events the user is allowed to view."

Returns:

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

See Also:

ALLOWALLEVENTS

isAllowAllEventsNull

public boolean isAllowAllEventsNull()

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

"If true, the user can view all event records in the Sentinel system. If false, the filter value is used to determine the set of events the user is allowed to view."

See the description of Null values.

Returns:

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

See Also:

setAllowAllEventsNull(), ALLOWALLEVENTS

isAllowAllEventsClear

public boolean isAllowAllEventsClear()

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

"If true, the user can view all event records in the Sentinel system. If false, the filter value is used to determine the set of events the user is allowed to view."

See the description of cleared values.

Returns:

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

See Also:

clearAllowAllEvents(), ALLOWALLEVENTS

setAllowAllEvents

public void setAllowAllEvents(boolean allowAllEvents)

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

"If true, the user can view all event records in the Sentinel system. If false, the filter value is used to determine the set of events the user is allowed to view."

Parameters:

allowAllEvents - Value to set

See Also:

ALLOWALLEVENTS

clearAllowAllEvents

public void clearAllowAllEvents()

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

"If true, the user can view all event records in the Sentinel system. If false, the filter value is used to determine the set of events the user is allowed to view."

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

See the description of cleared values.

See Also:

ALLOWALLEVENTS

setAllowAllEventsNull

public void setAllowAllEventsNull()

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

"If true, the user can view all event records in the Sentinel system. If false, the filter value is used to determine the set of events the user is allowed to view."

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

See the description of Null values.

See Also:

ALLOWALLEVENTS

getEffectivePermissions

public Collection<String> getEffectivePermissions()

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

"This collection contains the calculated set of permissions effective for the user based on the user's role memberships."

Returns:

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

See Also:

EFFECTIVEPERMISSIONS

isEffectivePermissionsNull

public boolean isEffectivePermissionsNull()

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

"This collection contains the calculated set of permissions effective for the user based on the user's role memberships."

See the description of Null values.

Returns:

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

See Also:

setEffectivePermissionsNull(), EFFECTIVEPERMISSIONS

isEffectivePermissionsClear

public boolean isEffectivePermissionsClear()

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

"This collection contains the calculated set of permissions effective for the user based on the user's role memberships."

See the description of cleared values.

Returns:

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

See Also:

clearEffectivePermissions(), EFFECTIVEPERMISSIONS

setEffectivePermissions

public void setEffectivePermissions(Collection<? extends String> effectivePermissions)

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

"This collection contains the calculated set of permissions effective for the user based on the user's role memberships."

Parameters:

effectivePermissions - Value to set

See Also:

EFFECTIVEPERMISSIONS

clearEffectivePermissions

public void clearEffectivePermissions()

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

"This collection contains the calculated set of permissions effective for the user based on the user's role memberships."

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

See the description of cleared values.

See Also:

EFFECTIVEPERMISSIONS

setEffectivePermissionsNull

public void setEffectivePermissionsNull()

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

"This collection contains the calculated set of permissions effective for the user based on the user's role memberships."

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

See the description of Null values.

See Also:

EFFECTIVEPERMISSIONS

addToEffectivePermissions

public void addToEffectivePermissions(String value)

Add a value to the collection field 'perm-set'. The description of the 'perm-set' field is:

"This collection contains the calculated set of permissions effective for the user based on the user's role memberships."

Parameters:

value - Value to add to collection.

See Also:

EFFECTIVEPERMISSIONS

isCanChangeOwnPassword

public boolean isCanChangeOwnPassword()

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

"If true, a user can change his own password."

Returns:

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

See Also:

CANCHANGEOWNPASSWORD

isCanChangeOwnPasswordNull

public boolean isCanChangeOwnPasswordNull()

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

"If true, a user can change his own password."

See the description of Null values.

Returns:

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

See Also:

setCanChangeOwnPasswordNull(), CANCHANGEOWNPASSWORD

isCanChangeOwnPasswordClear

public boolean isCanChangeOwnPasswordClear()

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

"If true, a user can change his own password."

See the description of cleared values.

Returns:

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

See Also:

clearCanChangeOwnPassword(), CANCHANGEOWNPASSWORD

setCanChangeOwnPassword

public void setCanChangeOwnPassword(boolean canChangeOwnPassword)

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

"If true, a user can change his own password."

Parameters:

canChangeOwnPassword - Value to set

See Also:

CANCHANGEOWNPASSWORD

clearCanChangeOwnPassword

public void clearCanChangeOwnPassword()

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

"If true, a user can change his own password."

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

See the description of cleared values.

See Also:

CANCHANGEOWNPASSWORD

setCanChangeOwnPasswordNull

public void setCanChangeOwnPasswordNull()

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

"If true, a user can change his own password."

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

See the description of Null values.

See Also:

CANCHANGEOWNPASSWORD

getEventFilter

public String getEventFilter()

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

"If non-empty, and AllowAllEvents is false, this value is a filter expression that determines the set of events the user is allowed to view."

Returns:

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

See Also:

EVENTFILTER

isEventFilterNull

public boolean isEventFilterNull()

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

"If non-empty, and AllowAllEvents is false, this value is a filter expression that determines the set of events the user is allowed to view."

See the description of Null values.

Returns:

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

See Also:

setEventFilterNull(), EVENTFILTER

isEventFilterClear

public boolean isEventFilterClear()

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

"If non-empty, and AllowAllEvents is false, this value is a filter expression that determines the set of events the user is allowed to view."

See the description of cleared values.

Returns:

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

See Also:

clearEventFilter(), EVENTFILTER

setEventFilter

public void setEventFilter(String eventFilter)

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

"If non-empty, and AllowAllEvents is false, this value is a filter expression that determines the set of events the user is allowed to view."

Parameters:

eventFilter - Value to set

See Also:

EVENTFILTER

clearEventFilter

public void clearEventFilter()

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

"If non-empty, and AllowAllEvents is false, this value is a filter expression that determines the set of events the user is allowed to view."

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

See the description of cleared values.

See Also:

EVENTFILTER

setEventFilterNull

public void setEventFilterNull()

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

"If non-empty, and AllowAllEvents is false, this value is a filter expression that determines the set of events the user is allowed to view."

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

See the description of Null values.

See Also:

EVENTFILTER

isAdmin

public boolean isAdmin()

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

"If true, the user has administrator privileges."

Returns:

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

See Also:

ADMIN

isAdminNull

public boolean isAdminNull()

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

"If true, the user has administrator privileges."

See the description of Null values.

Returns:

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

See Also:

setAdminNull(), ADMIN

isAdminClear

public boolean isAdminClear()

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

"If true, the user has administrator privileges."

See the description of cleared values.

Returns:

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

See Also:

clearAdmin(), ADMIN

setAdmin

public void setAdmin(boolean admin)

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

"If true, the user has administrator privileges."

Parameters:

admin - Value to set

See Also:

ADMIN

clearAdmin

public void clearAdmin()

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

"If true, the user has administrator privileges."

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

See the description of cleared values.

See Also:

ADMIN

setAdminNull

public void setAdminNull()

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

"If true, the user has administrator privileges."

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

See the description of Null values.

See Also:

ADMIN

getBeanMetaData

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

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

Overrides:

clone in class Object