com.novell.db.object.bean
Class ObjectSchemaBean

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

public class ObjectSchemaBean
extends SentinelBean

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

The description of the type is:

"A "schema" object describes an object available through 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

Field Summary

static String	APINAME The "bean name" of the Sentinel data object field 'ApiName'.
static String	ATTRIBUTES The "bean name" of the Sentinel data object field 'Attributes'.
static String	INTERNALNAME The "bean name" of the Sentinel data object field 'InternalName'.
static String	NEEDEDPERMISSIONS The "bean name" of the Sentinel data object field 'NeededPermissions'.
static String	STANDALONE The "bean name" of the Sentinel data object field 'Standalone'.
static String	TYPEURI The "bean name" of the Sentinel data object field 'TypeURI'.

Constructor Summary

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

Method Summary

ObjectSchemaBean	clone() Create a duplicate of this bean instance, including all field values.
String	getApiName() Get the value for the 'api-name' field.
Collection<AttributeSchemaBean>	getAttributes() Get the value for the 'attrs' field.
static BeanMetaData<? extends ObjectSchemaBean>	getBeanMetaData() Get the metadata class instance for this type.
String	getInternalName() Get the value for the 'internal-name' field.
Map<String,SchemaPermBean>	getNeededPermissions() Get the value for the 'perms' field.
String	getTypeURILink() Get the URL for the 'uri' field.
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	isAttributesClear() Get whether the value for the 'attrs' field is clear or not.
boolean	isAttributesNull() Get whether the 'attrs' 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	isNeededPermissionsClear() Get whether the value for the 'perms' field is clear or not.
boolean	isNeededPermissionsNull() Get whether the 'perms' field has been set to Null or not.
boolean	isStandalone() Get the value for the 'standalone' field.
boolean	isStandaloneClear() Get whether the value for the 'standalone' field is clear or not.
boolean	isStandaloneNull() Get whether the 'standalone' field has been set to Null or not.
boolean	isTypeURILinkClear() Get whether the value for the 'uri' URL field is clear or not.
boolean	isTypeURILinkNull() Get whether the 'uri' URL 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

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 object type. It is useful to know this name because generated bean classes available in the client API are named based on this name."

See Also:

Constant Field Values

TYPEURI

public static final String TYPEURI

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

The description of the 'uri' field is:

"The URI used with the REST API to access objects belonging to the type described by this ObjectSchema instance. This attribute will have no value for non-standalone types because such types only appear in values of other object types."

See Also:

Constant Field Values

ATTRIBUTES

public static final String ATTRIBUTES

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

The description of the 'attrs' field is:

"A list of type information for each attribute that can appear in the object type described by this Object Schema instance."

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 object type."

See Also:

Constant Field Values

STANDALONE

public static final String STANDALONE

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

The description of the 'standalone' field is:

"If this value is true it indicates that the object type is a "first class" type that can be directly manipulated via the REST API. If this value is false it indicates that the object type only appears in values of other object types."

See Also:

Constant Field Values

NEEDEDPERMISSIONS

public static final String NEEDEDPERMISSIONS

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

The description of the 'perms' field is:

"Information about access control for the object type described by this Object Schema instance. This value is empty for non-standalone types. The map keys are "view", "update", "create", and "delete"."

See Also:

Constant Field Values

Constructor Detail

ObjectSchemaBean

public ObjectSchemaBean()

Construct an instance of the bean class.

ObjectSchemaBean

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

getNeededPermissions

public Map<String,SchemaPermBean> getNeededPermissions()

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

"Information about access control for the object type described by this Object Schema instance. This value is empty for non-standalone types. The map keys are "view", "update", "create", and "delete"."

Returns:

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

See Also:

NEEDEDPERMISSIONS

isNeededPermissionsNull

public boolean isNeededPermissionsNull()

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

"Information about access control for the object type described by this Object Schema instance. This value is empty for non-standalone types. The map keys are "view", "update", "create", and "delete"."

See the description of Null values.

Returns:

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

See Also:

NEEDEDPERMISSIONS

isNeededPermissionsClear

public boolean isNeededPermissionsClear()

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

"Information about access control for the object type described by this Object Schema instance. This value is empty for non-standalone types. The map keys are "view", "update", "create", and "delete"."

See the description of cleared values.

Returns:

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

See Also:

NEEDEDPERMISSIONS

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 object type. It is useful to know this name because generated bean classes available in the client API are named 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 object type. It is useful to know this name because generated bean classes available in the client API are named 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 object type. It is useful to know this name because generated bean classes available in the client API are named based on this name."

See the description of cleared values.

Returns:

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

See Also:

INTERNALNAME

getAttributes

public Collection<AttributeSchemaBean> getAttributes()

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

"A list of type information for each attribute that can appear in the object type described by this Object Schema instance."

Returns:

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

See Also:

ATTRIBUTES

isAttributesNull

public boolean isAttributesNull()

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

"A list of type information for each attribute that can appear in the object type described by this Object Schema instance."

See the description of Null values.

Returns:

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

See Also:

ATTRIBUTES

isAttributesClear

public boolean isAttributesClear()

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

"A list of type information for each attribute that can appear in the object type described by this Object Schema instance."

See the description of cleared values.

Returns:

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

See Also:

ATTRIBUTES

isStandalone

public boolean isStandalone()

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

"If this value is true it indicates that the object type is a "first class" type that can be directly manipulated via the REST API. If this value is false it indicates that the object type only appears in values of other object types."

Returns:

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

See Also:

STANDALONE

isStandaloneNull

public boolean isStandaloneNull()

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

"If this value is true it indicates that the object type is a "first class" type that can be directly manipulated via the REST API. If this value is false it indicates that the object type only appears in values of other object types."

See the description of Null values.

Returns:

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

See Also:

STANDALONE

isStandaloneClear

public boolean isStandaloneClear()

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

"If this value is true it indicates that the object type is a "first class" type that can be directly manipulated via the REST API. If this value is false it indicates that the object type only appears in values of other object types."

See the description of cleared values.

Returns:

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

See Also:

STANDALONE

getTypeURILink

public String getTypeURILink()

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

"The URI used with the REST API to access objects belonging to the type described by this ObjectSchema instance. This attribute will have no value for non-standalone types because such types only appear in values of other object types."

Returns:

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

See Also:

TYPEURI

isTypeURILinkNull

public boolean isTypeURILinkNull()

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

"The URI used with the REST API to access objects belonging to the type described by this ObjectSchema instance. This attribute will have no value for non-standalone types because such types only appear in values of other object types."

See the description of Null values.

Returns:

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

See Also:

TYPEURI

isTypeURILinkClear

public boolean isTypeURILinkClear()

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

"The URI used with the REST API to access objects belonging to the type described by this ObjectSchema instance. This attribute will have no value for non-standalone types because such types only appear in values of other object types."

See the description of cleared values.

Returns:

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

See Also:

TYPEURI

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 object type."

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 object type."

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 object type."

See the description of cleared values.

Returns:

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

See Also:

APINAME

getBeanMetaData

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

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

Overrides:

clone in class Object