An object that represents a widget and it's properties.
| name | data type | type | namespace | min/max occurs | constraints | description |
|---|---|---|---|---|---|---|
| code | string | element | 0/1 | The string to be used for the div id, the placeholder image for this widget, and the name of the action and view of the widget content. | ||
| description | string | element | 0/1 | A description of this widget's functionality. | ||
| large | boolean | element | 1/1 | required boolean | ||
| medium | boolean | element | 1/1 | required boolean | ||
| name | string | element | 0/1 | The name of this widget, as shown to users. | ||
| permission | string | element | 0/1 | The string name of the permission associated with this widget. A user must have this permission to view the widget. | ||
| small | boolean | element | 1/1 | required boolean | ||
| type | string | element | 0/1 | The type of widget, i.e. how the data is displayed. This directly corresponds to images that represent that data type. | ||
| viewPath | string | element | 0/1 | The url where this widget gets its content | ||
| weight | long | element | 0/1 | The number of locations that this widget fills. | ||
Properties inherited from baseHibernateEntity |
||||||
| id | long | element | 0/1 | The unique internal ID of the object. | ||
| version | long | element | 0/1 | For internal use only. This is the serialization recorder for optimistic locking of several objects between sessions. | ||
Properties inherited from baseEntity |
||||||
| violations | list of simpleViolation | element | 0/unbounded | A list of constraint violations, if any, that this object has. | ||
Example
<widget> <weight>...</weight> <description>...</description> <name>...</name> <code>...</code> <permission>...</permission> <type>...</type> <viewPath>...</viewPath> <small>...</small> <medium>...</medium> <large>...</large> <id>...</id> <version>...</version> <violations/> </widget>