XEO Object Model Reference - Attribute Base Reference

This page contains a reference of properties that are applicable to all attributes types in a XEO Object Model.

Name

The name of the attribute. It's a required field and its value can be anything that it's not an SQL reserved word, as it's name of the attribute that will be used to create the corresponing column in the database table. When using the XEO's Java API, this is name to use when doing something like the following (assuming an attribute named "description").

boObject myObj = //retrieveObject code
myObj.getAttribute("description").getValueString()

_

Label

The label of the attribute. It's used especially with the XEO Web Components layer, in forms to edit instances of the XEO Object Model and in lists of instances (the label of a given column). It's also a required attribute.

Description

A description of the attribute, essentially used as documentation about the attribute.

Tooltip

A tooltip to be displayed along side the attribute when it's rendered in a form (at the present time it's not implemented in the XWC layer).

Attribute Behavior

This section groups all common attribute properties that are related to the attribute's behavior.

Required

Whether the attribute is required or not. If an attribute is required, every instance of a given Object Model which has a required attribute cannot be saved until the attribute has a value.

The required property can be set using BOL, the Java API , or smily boolean values ("1" and "0", for true and false respectivelly). Using boolean values, will make it that the attribute is always or never required. By using BOL or the Java API you can make it that the attribute is only required under some specific conditions.

When an attribute is used in a form, if it's required the attribute's label will be displayed in red.

onChangeSubmit

The onChangeSubmit property, makes it then this attribute is changed it triggers a new request

DefaultValue

Valid

Formula

DisableWhen

HiddenWhen

TextIndex

Events

Database