Page History
...
Class
| Attribute | Type | Description | Allowed Values | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AndQueryCondition | conditionTypeconditionsType | String | Type of the condition. | conjunction | Marks the condition as conjunction (and) of simple queries (default and not changeable). | |||||||
| condition | Array of QueryCondition | List of simple queries that are related by and.
| ||||||||||
| AttributeSortConditon | name | String | Name of the persistent state attribute to sort by.
| a valid persistent state attribute name with stereotype <<SearchKey>> | ||||||||
| direction | String | Sort direction as defined on SortCondition.
| ASC | Ascending sorting (default). | ||||||||
| DESC | Descending sorting. | |||||||||||
ClassAttributeMetadata | name | String | Name of the persistent state attribute. | |||||||||
| type | String | Type of the persistent state attribute, e.g.
| ||||||||||
| ClassCounters | name | String | Name of the persistent state class. | |||||||||
| count | Integer | Object count. | ||||||||||
| stalledCount | Integer | Count of objects that are stalled. | ||||||||||
| states | Array of StateCounters | List of states including count of objects in this state. | ||||||||||
| ClassInfo | name | String | Name of the persistent state class. | |||||||||
| count | Integer | Object count. | ||||||||||
| ClassMetadata | name | String | Name of the persistent state class. | |||||||||
| attributes | Array of ClassAttributeMetadata | List of class attributes and their metadata. | ||||||||||
| primaryKeys | Array of String | List of attributes that are marked as primary key with stereotype <<PrimaryKey>>.
| ||||||||||
| searchKeys | Array of String | List of attributes that are marked as search key with stereotype <<SearchKey>>. | ||||||||||
MetaAttributeSortCondition | name | String | Name of the persistent state meta attribute to sort by. | creation | Sort by creation date. | |||||||
| update | Sort by update date. | |||||||||||
| direction | String | Sort direction as defined on SortCondition.
| ASC | Ascending sorting (default). | ||||||||
| DESC | Descending sorting. | |||||||||||
| ObjectEntry | id | String | Unique identifier of the persistent state object. | |||||||||
| name | String | Name of the persistent state object. | ||||||||||
| creation | DateTime | Creation date of the object. | ||||||||||
| lastUpdate | DateTime | Date object has been last updated. | ||||||||||
| states | Array of String | List of states the object is in. | ||||||||||
| object | Any | Copy of the persistent state object. object contains the same content as would be returned by getObjectCopy of the Persistent State Adapter.
| ||||||||||
| OrQueryCondition | conditionTypeconditionsType | String | Type of the condition. | disjunction | Marks the condition as disjunction (or) of simple queries (default and not changeable). | |||||||
| condition | Array of QueryCondition | List of simple queries that are related by or. | ||||||||||
| Owner | id | String | Owner id. For more information on how to manage ownership of persistent state objects, refer to Persistent State Ownership. | |||||||||
| compositeName | String | Composite name from the xUML model. | ||||||||||
| host | String | Name of the host that runs the owner. | ||||||||||
| lastStartup | DateTime | Last recorded service startup. | ||||||||||
| lastShutdown | DateTime | Last recorded service shutdown. | ||||||||||
| ownedObjects | Integer | Count of owned objects. | ||||||||||
| isSelf | Boolean | True, if the current service is the owner. | true | The current service is the owner. | ||||||||
| false | The current service is not the owner. | |||||||||||
QueryCondition | Parent abstract class of SimpleQueryCondition, AndQueryCondition, or OrQueryCondition.
| |||||||||||
| SimpleQueryCondition | conditionTypeconditionsType | String | Type of the condition. | simple | Marks the condition as simple query condition (default and not changeable). | |||||||
| attribute | String | Name of the search key attribute to use for comparison. | valid name of an existent persistent state class attribute that has stereotype <<SearchKey>> | |||||||||
| operator | String | Operator for the comparison of attribute and value.
| = | Equal. | ||||||||
| != | Not equal. | |||||||||||
| < | Less than. | |||||||||||
| <= | Less or equal. | |||||||||||
| > | Greater than. | |||||||||||
| >= | Greater or equal. | |||||||||||
| ~ | Like (SQL). | |||||||||||
| !~ | Not like (SQL). | |||||||||||
| null | Null. | |||||||||||
| !null | Not null. | |||||||||||
| value | Any | Value to compare the attribute against. | Only base types allowed. The value must match the type of the specified attribute.
| |||||||||
| SelectObjectsQuery | classifier | String | Name of the persistent state class to query. | |||||||||
| creationFrom | DateTime | Creation date from. | ||||||||||
| creationTo | DateTime | Creation date to. | ||||||||||
| sortByCreation | String | Sort by creation date (ASC/DESC). Relates to sortByUpdate.
| ASC | Sort by creation date in ascending order. | ||||||||
| DESC | Sort by creation date in descending order. | |||||||||||
| updateFrom | DateTime | Update date from. | ||||||||||
| updateTo | DateTime | Update date to. | ||||||||||
| sortByUpdate | String | Sort by update date (ASC/DESC). Relates to sortByCreation.
| ASC | Sort by date of last update in ascending order. | ||||||||
| DESC | Sort by date of last update in descending order. | |||||||||||
| limit | Integer | Limit the count of returned objects. Default is 1000. | Default is 1000 objects. | |||||||||
| state | Array of String | List of states. A persistent state object must be in one of the states to be part of the result set (disjunction). | ||||||||||
| condition | QueryCondition | Query condition as described further above (see Querying Persistent State Objects of a Given Class). | ||||||||||
| skip | Integer | Skip the number of objects provided with skip. Together with limit, this allows to implement pagination.
| ||||||||||
| orderBy | Array of SortCondition | Provide sort conditions (list of persistent state attributes and direction). This array is translated into an
| ||||||||||
SortCondition | direction | String | Sort direction. | ASC | Ascending sorting (default). | |||||||
| DESC | Descending sorting. | |||||||||||
StateCounters | name | String | Name of the state. | |||||||||
| count | Integer | Count of objects in this state. | ||||||||||
| stalledCount | Integer | Count of stalled objects in this state. | ||||||||||
...
Overview
Content Tools