Data
- Default Namespace
The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.
The following elements are members of this namespace:
The following types are members of this namespace:
Element asset
- Type: gracenoteImage
The Gracenote(from Local DB) Image entity that represent the next xml:
Example XML
<?xml version="1.0" encoding="UTF-8"?><asset category="..." height="..." assetId="..." width="..." tier="..." type="..."> <URI>...</URI> <locale> <language>...</language> <country>...</country> </locale> <assetClassification>...</assetClassification> <imageType>...</imageType></asset>
Element image
- Type: galleryImage
The Gallery(Genre/Restricted) Image entity that represent the next xml:
Example XML
<?xml version="1.0" encoding="UTF-8"?><image category="..." height="..." width="..." type="..."> <URI>...</URI></image>
Element locale
- Type: gracenoteLocale
Example XML
<?xml version="1.0" encoding="UTF-8"?><locale> <language>...</language> <country>...</country></locale>
Element nameValuePairs
- Type: NameValuePairs
Example XML
<?xml version="1.0" encoding="UTF-8"?><nameValuePairs> <ns1:nameValuePair xmlns:ns1="http://opencase.extend.com/common"> <name>...</name> <value>...</value> </ns1:nameValuePair> <ns1:nameValuePair xmlns:ns1="http://opencase.extend.com/common"> <!--...--> </ns1:nameValuePair> <!--...more "nameValuePair" elements...--></nameValuePairs>
Element quartzJob
- Type: quartzJobData
Example XML
<?xml version="1.0" encoding="UTF-8"?><quartzJob> <ns1:jobDataList xmlns:ns1="http://opencase.extend.com/common"> <ns1:jobDataList>...</ns1:jobDataList> <ns1:jobDataList>...</ns1:jobDataList> <!--...more "jobDataList" elements...--> </ns1:jobDataList></quartzJob>
Element ruleSet
- Type: ruleSet
A Rule contains a list of Rules and a RuleCombinationType indicating whether they should be combined as a logical AND or a logical OR. TheRule is run by calling the fire method.
Example XML
<?xml version="1.0" encoding="UTF-8"?><ruleSet> <rules> <rule> <leftHandSide /> <comparisonType>...</comparisonType> <rightHandSide>...</rightHandSide> </rule> <rule> <!--...--> </rule> <!--...more "rule" elements...--> </rules> <ruleCombinationType>...</ruleCombinationType></ruleSet>
Element tokenExecutionHistory
- Type: tokenExecutionHistory
Container class for execution history for JBPM token.
Example XML
<?xml version="1.0" encoding="UTF-8"?><tokenExecutionHistory> <nodeHistoryList> <nodeName>...</nodeName> <incomingTransitionName>...</incomingTransitionName> </nodeHistoryList> <nodeHistoryList> <!--...--> </nodeHistoryList> <!--...more "nodeHistoryList" elements...--></tokenExecutionHistory>
Type abstractLeftHandSide
This class is used in various rules to represent one side of a comparison. This side contains business logic, different for each extendingclass, that returns 1 or more Strings based on an input String passed to the execute method.
Type comparisonType
Enum containing the valid comparisonTypes for use in a Rule
Possible Values
value | description |
---|---|
EQUALS | |
CONTAINS | |
MATCHES | |
EQULAS_IGNORE_CASE | |
MATCHES_IGNORE_CASE | |
CONTAINS_IGNORE_CASE |
Type config
An entry in the administration config tree
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
configPk (int) | 0/1 | Entity primary key |
name (string) | 0/1 | Config name - must not be blank; 255 characters maximum |
entry (string) | 0/1 | Get the config entry text - 4000 character maximum |
isUIAddingChildren (boolean) | 0/1 | Get the flag indicating if this config will allow the creation of child nodes via the UI |
isEncrypted (boolean) | 0/1 | Is this config entry encrypted? |
childrenConfig (config) | 0/unbounded | Get the child config entries |
uuid (string) | 0/1 | (no documentation provided) |
isRemovable (boolean) | 0/1 | Get the flag indicating if this config can be removed via the UI. |
isContainsFormData (boolean) | 0/1 | Get the flag indicating if this config contains a FormData instead of a string entry |
formData (formData) | 0/1 | Get the FormData associated with this config |
Type formData
Represents clob data that can be stored as Form, to be referenced by other entities that do not have clob columns to store the data.Optionally, the stored data can be based on a Template which is used to render it.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
uuid (string) | 0/1 | UUID getter |
dataClob (string) | 0/1 | Getter for the Clob data stored in the Form. |
formTemplate (formTemplate) | 0/1 | Getter for the template used to render the stored data |
Type formTemplate
Represents a Template, i.e. a set of rules to determine how data is to be displayed on the UI. Clob data stored in FormData objects can berendered using the associated FormTemplate.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
uuid (string) | 0/1 | UUID getter |
name (string) | 0/1 | Getter for the name of the form template |
templateClob (string) | 0/1 | Getter for the template data, that determines how FormData is to be displayed |
Type galleryImage
The Gallery(Genre/Restricted) Image entity that represent the next xml:
Attributes
name | type | description |
---|---|---|
category | string | (no documentation provided) |
height | int | (no documentation provided) |
width | int | (no documentation provided) |
type | string | (no documentation provided) |
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
URI (string) | 0/1 | (no documentation provided) |
Type gracenoteImage
The Gracenote(from Local DB) Image entity that represent the next xml:
Attributes
name | type | description |
---|---|---|
category | string | category |
height | int | height |
assetId | string | assetId |
width | int | width |
tier | string | (no documentation provided) |
type | string | mimeType |
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
URI (string) | 0/1 | Gets the uri for the image. |
locale (gracenoteLocale) | 0/1 | Gets locale of gracenote image. |
assetClassification (string) | 0/1 | Gets the asset classification for the image. |
imageType (string) | 0/1 | The image type: Gracenote supplied image (from Program Local EPG), Gallery Restricted image, Gallery Genre image |
Type gracenoteLocale
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
language (string) | 0/1 | (no documentation provided) |
country (string) | 0/1 | (no documentation provided) |
Type jobData
This class store the name and value for job properties
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
name (string) | 0/1 | (no documentation provided) |
value (string) | 0/1 | (no documentation provided) |
Type nodeHistory
Container class that represents visited JBPM node.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
nodeName (string) | 1/1 | Gets the node name of visited Workflow node. |
incomingTransitionName (string) | 0/1 | Gets the incoming transition name of visited Workflow node. |
Type quartzJobData
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
jobDataList/jobData () | 0/unbounded | (no documentation provided) |
Type rule
A Rule contains left and right hand sides and a comparisonType. An execute method contains the appropriate code to 'fire' the rule anddetermine if it is true or false for the given input data.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
leftHandSide (abstractLeftHandSide) | 0/1 | (no documentation provided) |
comparisonType (comparisonType) | 0/1 | (no documentation provided) |
rightHandSide (string) | 0/1 | (no documentation provided) |
Type ruleSet
A Rule contains a list of Rules and a RuleCombinationType indicating whether they should be combined as a logical AND or a logical OR. TheRule is run by calling the fire method.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
rules/rule (rule) | 0/unbounded | (no documentation provided) |
ruleCombinationType (ruleCombinationType) | 0/1 | (no documentation provided) |
Type tokenExecutionHistory
Container class for execution history for JBPM token.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
nodeHistoryList (nodeHistory) | 1/unbounded | (no documentation provided) |
Type User
Class represents userName and user email address from SSO server
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
userName (string) | 0/1 | Returns name of user. |
email (string) | 0/1 | Returns emailAdress of user. |
restrictionKey (string) | 0/1 | Returns user restriction key. |
isRestrictionKeyExists (boolean) | 0/1 | Returns RestrictionKeyExists in database flag. |
isRestrictionKeyPublished (boolean) | 1/1 | Returns RestrictionKeyPublished flag. |