com.novell.db.object.bean
Class SchemaPermBean

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

public class SchemaPermBean
extends SentinelBean

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

The description of the type is:

"A "schema-perm" object describes the permissions needed to perform an operation (View, Update, Create, Delete) on a standalone object."

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	ALLOWANY The "bean name" of the Sentinel data object field 'AllowAny'.
static String	PERMISSIONS The "bean name" of the Sentinel data object field 'Permissions'.

Constructor Summary

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

Method Summary

SchemaPermBean	clone() Create a duplicate of this bean instance, including all field values.
static BeanMetaData<? extends SchemaPermBean>	getBeanMetaData() Get the metadata class instance for this type.
Collection<String>	getPermissions() Get the value for the 'perms' field.
boolean	isAllowAny() Get the value for the 'allow-any' field.
boolean	isAllowAnyClear() Get whether the value for the 'allow-any' field is clear or not.
boolean	isAllowAnyNull() Get whether the 'allow-any' field has been set to Null or not.
boolean	isPermissionsClear() Get whether the value for the 'perms' field is clear or not.
boolean	isPermissionsNull() Get whether the 'perms' field has been set to Null or not.

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

ALLOWANY

public static final String ALLOWANY

The "bean name" of the Sentinel data object field 'AllowAny'. The value is ""allow-any"".

The description of the 'allow-any' field is:

"If true, indicates that access is permitted for any authenticated user. If false, indicates that a specific permission is required."

See Also:

Constant Field Values

PERMISSIONS

public static final String PERMISSIONS

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

The description of the 'perms' field is:

"A list of permission names, any one of which is needed to perform the operation. Note that "_adminRole_" is a special permission name that indicates that a user must be a member of the Sentinel role "Administrators"."

See Also:

Constant Field Values

Constructor Detail

SchemaPermBean

public SchemaPermBean()

Construct an instance of the bean class.

SchemaPermBean

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

getPermissions

public Collection<String> getPermissions()

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

"A list of permission names, any one of which is needed to perform the operation. Note that "_adminRole_" is a special permission name that indicates that a user must be a member of the Sentinel role "Administrators"."

Returns:

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

See Also:

PERMISSIONS

isPermissionsNull

public boolean isPermissionsNull()

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

"A list of permission names, any one of which is needed to perform the operation. Note that "_adminRole_" is a special permission name that indicates that a user must be a member of the Sentinel role "Administrators"."

See the description of Null values.

Returns:

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

See Also:

PERMISSIONS

isPermissionsClear

public boolean isPermissionsClear()

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

"A list of permission names, any one of which is needed to perform the operation. Note that "_adminRole_" is a special permission name that indicates that a user must be a member of the Sentinel role "Administrators"."

See the description of cleared values.

Returns:

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

See Also:

PERMISSIONS

isAllowAny

public boolean isAllowAny()

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

"If true, indicates that access is permitted for any authenticated user. If false, indicates that a specific permission is required."

Returns:

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

See Also:

ALLOWANY

isAllowAnyNull

public boolean isAllowAnyNull()

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

"If true, indicates that access is permitted for any authenticated user. If false, indicates that a specific permission is required."

See the description of Null values.

Returns:

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

See Also:

ALLOWANY

isAllowAnyClear

public boolean isAllowAnyClear()

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

"If true, indicates that access is permitted for any authenticated user. If false, indicates that a specific permission is required."

See the description of cleared values.

Returns:

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

See Also:

ALLOWANY

getBeanMetaData

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

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

Overrides:

clone in class Object