Difference between revisions of "CustomDataCacheSpecificationBuildResult class"
(Tag: visualeditor) |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 2: | Line 2: | ||
|Name=<nowiki>CustomDataCacheSpecificationBuildResult</nowiki> | |Name=<nowiki>CustomDataCacheSpecificationBuildResult</nowiki> | ||
|Description=<nowiki>Represents a DataCache specification build result.</nowiki> | |Description=<nowiki>Represents a DataCache specification build result.</nowiki> | ||
| − | |Constructors= | + | |InheritsFrom=object|Constructors= |
{{CGscriptConstructors_Template|Description=<nowiki>Create a new result set for a dcs</nowiki>}} | {{CGscriptConstructors_Template|Description=<nowiki>Create a new result set for a dcs</nowiki>}} | ||
|Methods= | |Methods= | ||
| Line 8: | Line 8: | ||
{{CGscriptParameters_Template|Type=string|Name=<nowiki>variableName</nowiki>|Description=<nowiki>Name of constant that is available in custom scripts in this DCS. Takes precedence over column names</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to store</nowiki>}} | {{CGscriptParameters_Template|Type=string|Name=<nowiki>variableName</nowiki>|Description=<nowiki>Name of constant that is available in custom scripts in this DCS. Takes precedence over column names</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to store</nowiki>}} | ||
|Description=<nowiki>Set additional output values. These can be accessed as predefined variables in all full column custom columns</nowiki>}} | |Description=<nowiki>Set additional output values. These can be accessed as predefined variables in all full column custom columns</nowiki>}} | ||
| − | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}} | + | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}} |
|Properties= | |Properties= | ||
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Ids</nowiki>|HasGetter=1|Description=<nowiki>Set the ids of the result set (Must be unique integer). These can be accessed by using the variable SYS_SCRIPT_UNIQUEID_SYS. | {{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Ids</nowiki>|HasGetter=1|Description=<nowiki>Set the ids of the result set (Must be unique integer). These can be accessed by using the variable SYS_SCRIPT_UNIQUEID_SYS. | ||
| Line 15: | Line 15: | ||
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>NonUniqueIds</nowiki>|HasGetter=1|Description=<nowiki>Set the non-unique ids of the result set (integer only). These can be accessed by using the variable SYS_SCRIPT_NONUNIQUEID_SYS</nowiki>}} | {{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>NonUniqueIds</nowiki>|HasGetter=1|Description=<nowiki>Set the non-unique ids of the result set (integer only). These can be accessed by using the variable SYS_SCRIPT_NONUNIQUEID_SYS</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | ||
| − | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}} | + | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}} |
}} | }} | ||
| + | |||
| + | === <span style="color:#DF8621">'''Note'''</span> === | ||
| + | This class is used on workflow of DCS using script. See more how DCS using script [[DCS Using Script|here]] | ||
=== <span style="color:#DF8621">'''Examples'''</span> === | === <span style="color:#DF8621">'''Examples'''</span> === | ||
| − | |||
<source lang="javascript"> | <source lang="javascript"> | ||
array param = Workflow_getParameters(); | array param = Workflow_getParameters(); | ||
| Line 49: | Line 51: | ||
</source> | </source> | ||
| − | |||
| − | |||
Latest revision as of 07:43, 2 July 2020
CustomDataCacheSpecificationBuildResult
Represents a DataCache specification build result.
Parent class
Inherits from object
Constructors
- () - Create a new result set for a dcs
Methods
- Empty AddVariableForFullCustomColumns(string variableName "Name of constant that is available in custom scripts in this DCS. Takes precedence over column names", object value "Value to store") - Set additional output values. These can be accessed as predefined variables in all full column custom columns
- (From object) string ToString() - The string representation of the object.
Properties
- array Ids { get; } - Set the ids of the result set (Must be unique integer). These can be accessed by using the variable SYS_SCRIPT_UNIQUEID_SYS.
The length of this array must match the length of NonUniqueIds.
If doing partial rebuilds, then any ids returned that match a previous builds id result in that row being updated
- array NonUniqueIds { get; } - Set the non-unique ids of the result set (integer only). These can be accessed by using the variable SYS_SCRIPT_NONUNIQUEID_SYS
- string ObjectTypeName { get; } - The name of the type of object.
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.
Note
This class is used on workflow of DCS using script. See more how DCS using script here
Examples
array param = Workflow_getParameters();
array a = param[0];
array fromDateTime = param[1];
array NonUniqueIds = param[2];
array UniqueIds = param[3];
array extraParameter = param[4];
Dictionary d1 =
{
"NonUniqueIds": NonUniqueIds,
"UniqueId": UniqueIds
};
Dictionary d2 =
{
"NonUniqueIds": {5,6,7,8,9,10,12},
"UniqueId": {0,1,2,3,4,11,13}
};
CustomDataCacheSpecificationBuildResult res = new CustomDataCacheSpecificationBuildResult();
Dictionary d = fromDateTime == empty ? d2 : d1;
res.NonUniqueIds.AddRange(d["NonUniqueIds"]);
res.Ids.AddRange(d["UniqueId"]);
return res;
