com.novell.db.object.bean
Class AttributeSchemaBean

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

public class AttributeSchemaBean
extends SentinelBean

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

The description of the type is:

"An "attr-schema" object contains information describing an attribute of an object type available via the Sentinel DataObject REST API."

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	AttributeSchemaBean.AccessType An enumerated type representing values for the field 'access'.
static class	AttributeSchemaBean.KeySubTypeType An enumerated type representing values for the field 'key-type'.
static class	AttributeSchemaBean.LinkTargetTypeType An enumerated type representing values for the field 'link-type'.
static class	AttributeSchemaBean.TypeType An enumerated type representing values for the field 'type'.
static class	AttributeSchemaBean.ValueSubTypeType An enumerated type representing values for the field 'sub-type'.

Field Summary

static String	ACCESS The "bean name" of the Sentinel data object field 'Access'.
static String	APINAME The "bean name" of the Sentinel data object field 'ApiName'.
static String	BEANKEYSUBTYPE The "bean name" of the Sentinel data object field 'BeanKeySubType'.
static String	BEANVALUESUBTYPE The "bean name" of the Sentinel data object field 'BeanValueSubType'.
static String	ENUMVALUES The "bean name" of the Sentinel data object field 'EnumValues'.
static String	INTERNALNAME The "bean name" of the Sentinel data object field 'InternalName'.
static String	KEYSUBTYPE The "bean name" of the Sentinel data object field 'KeySubType'.
static String	LINKTARGETTYPE The "bean name" of the Sentinel data object field 'LinkTargetType'.
static String	REQUIRED The "bean name" of the Sentinel data object field 'Required'.
static String	TYPE The "bean name" of the Sentinel data object field 'Type'.
static String	VALUESUBTYPE The "bean name" of the Sentinel data object field 'ValueSubType'.

Constructor Summary

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

Method Summary

AttributeSchemaBean	clone() Create a duplicate of this bean instance, including all field values.
AttributeSchemaBean.AccessType	getAccess() Get the value for the 'access' field.
String	getApiName() Get the value for the 'api-name' field.
String	getBeanKeySubType() Get the value for the 'bean-key-type' field.
static BeanMetaData<? extends AttributeSchemaBean>	getBeanMetaData() Get the metadata class instance for this type.
String	getBeanValueSubType() Get the value for the 'bean-value-type' field.
Collection<String>	getEnumValues() Get the value for the 'enums' field.
String	getInternalName() Get the value for the 'internal-name' field.
AttributeSchemaBean.KeySubTypeType	getKeySubType() Get the value for the 'key-type' field.
AttributeSchemaBean.LinkTargetTypeType	getLinkTargetType() Get the value for the 'link-type' field.
AttributeSchemaBean.TypeType	getType() Get the value for the 'type' field.
AttributeSchemaBean.ValueSubTypeType	getValueSubType() Get the value for the 'sub-type' field.
boolean	isAccessClear() Get whether the value for the 'access' field is clear or not.
boolean	isAccessNull() Get whether the 'access' field has been set to Null or not.
boolean	isApiNameClear() Get whether the value for the 'api-name' field is clear or not.
boolean	isApiNameNull() Get whether the 'api-name' field has been set to Null or not.
boolean	isBeanKeySubTypeClear() Get whether the value for the 'bean-key-type' field is clear or not.
boolean	isBeanKeySubTypeNull() Get whether the 'bean-key-type' field has been set to Null or not.
boolean	isBeanValueSubTypeClear() Get whether the value for the 'bean-value-type' field is clear or not.
boolean	isBeanValueSubTypeNull() Get whether the 'bean-value-type' field has been set to Null or not.
boolean	isEnumValuesClear() Get whether the value for the 'enums' field is clear or not.
boolean	isEnumValuesNull() Get whether the 'enums' field has been set to Null or not.
boolean	isInternalNameClear() Get whether the value for the 'internal-name' field is clear or not.
boolean	isInternalNameNull() Get whether the 'internal-name' field has been set to Null or not.
boolean	isKeySubTypeClear() Get whether the value for the 'key-type' field is clear or not.
boolean	isKeySubTypeNull() Get whether the 'key-type' field has been set to Null or not.
boolean	isLinkTargetTypeClear() Get whether the value for the 'link-type' field is clear or not.
boolean	isLinkTargetTypeNull() Get whether the 'link-type' field has been set to Null or not.
boolean	isRequired() Get the value for the 'required' field.
boolean	isRequiredClear() Get whether the value for the 'required' field is clear or not.
boolean	isRequiredNull() Get whether the 'required' field has been set to Null or not.
boolean	isTypeClear() Get whether the value for the 'type' field is clear or not.
boolean	isTypeNull() Get whether the 'type' field has been set to Null or not.
boolean	isValueSubTypeClear() Get whether the value for the 'sub-type' field is clear or not.
boolean	isValueSubTypeNull() Get whether the 'sub-type' 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

ACCESS

public static final String ACCESS

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

The description of the 'access' field is:

"Describes whether the attribute may be read, changed, or both. The value "write-only" is used for user passwords."

See Also:

Constant Field Values

INTERNALNAME

public static final String INTERNALNAME

The "bean name" of the Sentinel data object field 'InternalName'. The value is ""internal-name"".

The description of the 'internal-name' field is:

"The name used internally by Sentinel to refer to the attribute. It is useful to know this name because generated bean classes contain access methods whose names are created based on this name."

See Also:

Constant Field Values

KEYSUBTYPE

public static final String KEYSUBTYPE

The "bean name" of the Sentinel data object field 'KeySubType'. The value is ""key-type"".

The description of the 'key-type' field is:

"Describes the key type for "map" attribute types."

See Also:

Constant Field Values

BEANVALUESUBTYPE

public static final String BEANVALUESUBTYPE

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

The description of the 'bean-value-type' field is:

"Contains the name of the referenced object type if "type" is "bean", or if "sub-type" is "bean", or if "link-type" is "bean", or if "link-type" is "beans"."

See Also:

Constant Field Values

LINKTARGETTYPE

public static final String LINKTARGETTYPE

The "bean name" of the Sentinel data object field 'LinkTargetType'. The value is ""link-type"".

The description of the 'link-type' field is:

"Describes type of object referenced by the URL value for "link" attribute types."

See Also:

Constant Field Values

APINAME

public static final String APINAME

The "bean name" of the Sentinel data object field 'ApiName'. The value is ""api-name"".

The description of the 'api-name' field is:

"The name used in the serialized representation of the attribute value."

See Also:

Constant Field Values

REQUIRED

public static final String REQUIRED

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

The description of the 'required' field is:

"If true, the attribute must have a value when an object is created, and the attribute value may not be set to empty in a modify operation."

See Also:

Constant Field Values

ENUMVALUES

public static final String ENUMVALUES

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

The description of the 'enums' field is:

"If set and non-empty then "enums" is the set of allowed values for the attribute."

See Also:

Constant Field Values

VALUESUBTYPE

public static final String VALUESUBTYPE

The "bean name" of the Sentinel data object field 'ValueSubType'. The value is ""sub-type"".

The description of the 'sub-type' field is:

"Describes the element type for "set" and "list" attribute types, and the value type for "map" attribute types."

See Also:

Constant Field Values

TYPE

public static final String TYPE

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

The description of the 'type' field is:

"Describes the attribute value type. If "type" is "bean" then "bean-value-type" is the "api name" of the object type. If "type" is "list" or "set" then "sub-type" is the type of the collection element. If "type" is "map" then "key-type" is the type of the map keys, and "sub-type" is the type of the map values. If "type" is "link" then "link-type" is the type of item pointed to by the URL value of the attribute."

See Also:

Constant Field Values

BEANKEYSUBTYPE

public static final String BEANKEYSUBTYPE

The "bean name" of the Sentinel data object field 'BeanKeySubType'. The value is ""bean-key-type"".

The description of the 'bean-key-type' field is:

"Contains the name of the referenced object type if "key-type" is "bean"."

See Also:

Constant Field Values

Constructor Detail

AttributeSchemaBean

public AttributeSchemaBean()

Construct an instance of the bean class.

AttributeSchemaBean

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

getBeanKeySubType

public String getBeanKeySubType()

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

"Contains the name of the referenced object type if "key-type" is "bean"."

Returns:

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

See Also:

BEANKEYSUBTYPE

isBeanKeySubTypeNull

public boolean isBeanKeySubTypeNull()

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

"Contains the name of the referenced object type if "key-type" is "bean"."

See the description of Null values.

Returns:

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

See Also:

BEANKEYSUBTYPE

isBeanKeySubTypeClear

public boolean isBeanKeySubTypeClear()

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

"Contains the name of the referenced object type if "key-type" is "bean"."

See the description of cleared values.

Returns:

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

See Also:

BEANKEYSUBTYPE

getLinkTargetType

public AttributeSchemaBean.LinkTargetTypeType getLinkTargetType()

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

"Describes type of object referenced by the URL value for "link" attribute types."

Returns:

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

See Also:

LINKTARGETTYPE

isLinkTargetTypeNull

public boolean isLinkTargetTypeNull()

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

"Describes type of object referenced by the URL value for "link" attribute types."

See the description of Null values.

Returns:

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

See Also:

LINKTARGETTYPE

isLinkTargetTypeClear

public boolean isLinkTargetTypeClear()

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

"Describes type of object referenced by the URL value for "link" attribute types."

See the description of cleared values.

Returns:

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

See Also:

LINKTARGETTYPE

getValueSubType

public AttributeSchemaBean.ValueSubTypeType getValueSubType()

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

"Describes the element type for "set" and "list" attribute types, and the value type for "map" attribute types."

Returns:

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

See Also:

VALUESUBTYPE

isValueSubTypeNull

public boolean isValueSubTypeNull()

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

"Describes the element type for "set" and "list" attribute types, and the value type for "map" attribute types."

See the description of Null values.

Returns:

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

See Also:

VALUESUBTYPE

isValueSubTypeClear

public boolean isValueSubTypeClear()

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

"Describes the element type for "set" and "list" attribute types, and the value type for "map" attribute types."

See the description of cleared values.

Returns:

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

See Also:

VALUESUBTYPE

getInternalName

public String getInternalName()

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

"The name used internally by Sentinel to refer to the attribute. It is useful to know this name because generated bean classes contain access methods whose names are created based on this name."

Returns:

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

See Also:

INTERNALNAME

isInternalNameNull

public boolean isInternalNameNull()

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

"The name used internally by Sentinel to refer to the attribute. It is useful to know this name because generated bean classes contain access methods whose names are created based on this name."

See the description of Null values.

Returns:

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

See Also:

INTERNALNAME

isInternalNameClear

public boolean isInternalNameClear()

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

"The name used internally by Sentinel to refer to the attribute. It is useful to know this name because generated bean classes contain access methods whose names are created based on this name."

See the description of cleared values.

Returns:

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

See Also:

INTERNALNAME

getKeySubType

public AttributeSchemaBean.KeySubTypeType getKeySubType()

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

"Describes the key type for "map" attribute types."

Returns:

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

See Also:

KEYSUBTYPE

isKeySubTypeNull

public boolean isKeySubTypeNull()

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

"Describes the key type for "map" attribute types."

See the description of Null values.

Returns:

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

See Also:

KEYSUBTYPE

isKeySubTypeClear

public boolean isKeySubTypeClear()

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

"Describes the key type for "map" attribute types."

See the description of cleared values.

Returns:

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

See Also:

KEYSUBTYPE

getType

public AttributeSchemaBean.TypeType getType()

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

"Describes the attribute value type. If "type" is "bean" then "bean-value-type" is the "api name" of the object type. If "type" is "list" or "set" then "sub-type" is the type of the collection element. If "type" is "map" then "key-type" is the type of the map keys, and "sub-type" is the type of the map values. If "type" is "link" then "link-type" is the type of item pointed to by the URL value of the attribute."

Returns:

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

See Also:

TYPE

isTypeNull

public boolean isTypeNull()

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

"Describes the attribute value type. If "type" is "bean" then "bean-value-type" is the "api name" of the object type. If "type" is "list" or "set" then "sub-type" is the type of the collection element. If "type" is "map" then "key-type" is the type of the map keys, and "sub-type" is the type of the map values. If "type" is "link" then "link-type" is the type of item pointed to by the URL value of the attribute."

See the description of Null values.

Returns:

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

See Also:

TYPE

isTypeClear

public boolean isTypeClear()

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

"Describes the attribute value type. If "type" is "bean" then "bean-value-type" is the "api name" of the object type. If "type" is "list" or "set" then "sub-type" is the type of the collection element. If "type" is "map" then "key-type" is the type of the map keys, and "sub-type" is the type of the map values. If "type" is "link" then "link-type" is the type of item pointed to by the URL value of the attribute."

See the description of cleared values.

Returns:

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

See Also:

TYPE

getAccess

public AttributeSchemaBean.AccessType getAccess()

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

"Describes whether the attribute may be read, changed, or both. The value "write-only" is used for user passwords."

Returns:

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

See Also:

ACCESS

isAccessNull

public boolean isAccessNull()

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

"Describes whether the attribute may be read, changed, or both. The value "write-only" is used for user passwords."

See the description of Null values.

Returns:

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

See Also:

ACCESS

isAccessClear

public boolean isAccessClear()

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

"Describes whether the attribute may be read, changed, or both. The value "write-only" is used for user passwords."

See the description of cleared values.

Returns:

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

See Also:

ACCESS

isRequired

public boolean isRequired()

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

"If true, the attribute must have a value when an object is created, and the attribute value may not be set to empty in a modify operation."

Returns:

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

See Also:

REQUIRED

isRequiredNull

public boolean isRequiredNull()

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

"If true, the attribute must have a value when an object is created, and the attribute value may not be set to empty in a modify operation."

See the description of Null values.

Returns:

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

See Also:

REQUIRED

isRequiredClear

public boolean isRequiredClear()

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

"If true, the attribute must have a value when an object is created, and the attribute value may not be set to empty in a modify operation."

See the description of cleared values.

Returns:

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

See Also:

REQUIRED

getBeanValueSubType

public String getBeanValueSubType()

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

"Contains the name of the referenced object type if "type" is "bean", or if "sub-type" is "bean", or if "link-type" is "bean", or if "link-type" is "beans"."

Returns:

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

See Also:

BEANVALUESUBTYPE

isBeanValueSubTypeNull

public boolean isBeanValueSubTypeNull()

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

"Contains the name of the referenced object type if "type" is "bean", or if "sub-type" is "bean", or if "link-type" is "bean", or if "link-type" is "beans"."

See the description of Null values.

Returns:

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

See Also:

BEANVALUESUBTYPE

isBeanValueSubTypeClear

public boolean isBeanValueSubTypeClear()

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

"Contains the name of the referenced object type if "type" is "bean", or if "sub-type" is "bean", or if "link-type" is "bean", or if "link-type" is "beans"."

See the description of cleared values.

Returns:

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

See Also:

BEANVALUESUBTYPE

getApiName

public String getApiName()

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

"The name used in the serialized representation of the attribute value."

Returns:

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

See Also:

APINAME

isApiNameNull

public boolean isApiNameNull()

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

"The name used in the serialized representation of the attribute value."

See the description of Null values.

Returns:

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

See Also:

APINAME

isApiNameClear

public boolean isApiNameClear()

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

"The name used in the serialized representation of the attribute value."

See the description of cleared values.

Returns:

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

See Also:

APINAME

getEnumValues

public Collection<String> getEnumValues()

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

"If set and non-empty then "enums" is the set of allowed values for the attribute."

Returns:

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

See Also:

ENUMVALUES

isEnumValuesNull

public boolean isEnumValuesNull()

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

"If set and non-empty then "enums" is the set of allowed values for the attribute."

See the description of Null values.

Returns:

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

See Also:

ENUMVALUES

isEnumValuesClear

public boolean isEnumValuesClear()

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

"If set and non-empty then "enums" is the set of allowed values for the attribute."

See the description of cleared values.

Returns:

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

See Also:

ENUMVALUES

getBeanMetaData

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

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

Overrides:

clone in class Object