Class ActionActivity
Represents source code in a specified language to be executed as part of a survey Instrument.
Inheritance
Inherited Members
Namespace: Algenta.Colectica.Model.Ddi
Assembly: Algenta.Colectica.Model.Ddi.dll
Syntax
public class ActionActivity : ActivityBase, IVersionable, IHasCustomFields, IDescribable, IBindable, IIdentifiable, IVisitable
Constructors
ActionActivity()
Initializes a new instance of the ActionActivity class.
Declaration
public ActionActivity()
Fields
Blaise5DataLookupType
Value for TypeOfComputationKey to denote a Blaise 5 data LOOKUP.
Declaration
public static string Blaise5DataLookupType
Field Value
Type | Description |
---|---|
System.String |
ComputationType
Value for TypeOfComputationKey to denote a computation
Declaration
public static string ComputationType
Field Value
Type | Description |
---|---|
System.String |
EditCheckEnforcementLevelKey
user attribute key for the enforcement level of an edit check, Hard or Soft
Declaration
public static string EditCheckEnforcementLevelKey
Field Value
Type | Description |
---|---|
System.String |
EditCheckPromptKey
user attribute key to store the prompt of an edit check. The value is a json multilingual string.
Declaration
public static string EditCheckPromptKey
Field Value
Type | Description |
---|---|
System.String |
EditCheckType
Value for TypeOfComputationKey to denote an edit check
Declaration
public static string EditCheckType
Field Value
Type | Description |
---|---|
System.String |
gotoLanguage
Gets the string used to represent the language used to indicate that this
action represents a goto
instruction.
Declaration
public const string gotoLanguage = null
Field Value
Type | Description |
---|---|
System.String |
HardEditCheckEnforcementLevel
Hard edit check enforcement level
Declaration
public static string HardEditCheckEnforcementLevel
Field Value
Type | Description |
---|---|
System.String |
OutParameterScopeTypes
specify the type of output parameter. In 3.3 and beyond this is stored directly on the parameter as a user attribute
Declaration
public Dictionary<string, string> OutParameterScopeTypes
Field Value
Type | Description |
---|---|
Dictionary<System.String, System.String> |
OutParameterTypeScopeKey
user attribute key to store the requested scope type of output. The value is a json dictionary.
Declaration
public static string OutParameterTypeScopeKey
Field Value
Type | Description |
---|---|
System.String |
SoftEditCheckEnforcementLevel
Soft edit check enforcement level
Declaration
public static string SoftEditCheckEnforcementLevel
Field Value
Type | Description |
---|---|
System.String |
TypeOfComputationKey
user attribute key for type of computation
Declaration
public static string TypeOfComputationKey
Field Value
Type | Description |
---|---|
System.String |
Properties
ActionSourceCode
Gets or sets the source code.
Declaration
public SourceCodeCollection ActionSourceCode { get; set; }
Property Value
Type | Description |
---|---|
SourceCodeCollection |
CurrentSourceCode
Gets the source code for the currently active source language.
Declaration
public SourceCode CurrentSourceCode { get; }
Property Value
Type | Description |
---|---|
SourceCode |
DisplayLabel
Gets the display label.
Declaration
public override string DisplayLabel { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
Remarks
The display label returns text to be displayed in a user interface or in generated documentation.
EditCheckPrompt
Text of an edit prompt
Declaration
public MultilingualString EditCheckPrompt { get; }
Property Value
Type | Description |
---|---|
MultilingualString |
IsBlaise5DataLookup
Gets a value indicating whether this action represents a Blaise 5 data LOOKUP.
Declaration
public bool IsBlaise5DataLookup { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsComputation
Gets a value indicating whether this action represents a computation.
Declaration
public bool IsComputation { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsEditCheck
Gets a value indicating whether this action represents an edit check instruction.
Declaration
public bool IsEditCheck { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsGoto
Gets a value indicating whether this action represents a goto
instruction.
Declaration
public bool IsGoto { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
ItemType
Gets the type of the item.
Declaration
public override Guid ItemType { get; }
Property Value
Type | Description |
---|---|
Guid | The type of the item. |
Overrides
TargetName
Gets or sets the target of a goto
instruction.
Declaration
public string TargetName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Methods
GetChildren()
Gets the identifiers of the item's children.
Declaration
public override ChildItemCollection GetChildren()
Returns
Type | Description |
---|---|
ChildItemCollection | The identifiers of the item's children. |
Overrides
GetSourceCodeForLanguage(String)
Gets the source code for the specified language.
Declaration
public SourceCode GetSourceCodeForLanguage(string language)
Parameters
Type | Name | Description |
---|---|---|
System.String | language | The source code language. |
Returns
Type | Description |
---|---|
SourceCode | The source code for the language, if any exists; otherwise |
HasLanguage(String)
Gets a value indicating whether any source code exists for the specified language.
Declaration
public bool HasLanguage(string language)
Parameters
Type | Name | Description |
---|---|---|
System.String | language | The source code language. |
Returns
Type | Description |
---|---|
System.Boolean |
|
RemoveChild(IdentifierTriple)
Removes the specified child.
Declaration
public override int RemoveChild(IdentifierTriple child)
Parameters
Type | Name | Description |
---|---|---|
IdentifierTriple | child | The child to be removed. |
Returns
Type | Description |
---|---|
System.Int32 | The number of children removed from the item. |
Overrides
ReplaceChild(IdentifierTriple, IVersionable)
Replaces the child with the specified identifier with the provided item.
Declaration
public override int ReplaceChild(IdentifierTriple toReplace, IVersionable child)
Parameters
Type | Name | Description |
---|---|---|
IdentifierTriple | toReplace | The identifier of the child to replace. |
IVersionable | child | The new child. |
Returns
Type | Description |
---|---|
System.Int32 | The number of children replaced. |
Overrides
SetSourceCodeForLanguage(String, String)
Sets the source code for the specified language.
Declaration
public void SetSourceCodeForLanguage(string language, string value)
Parameters
Type | Name | Description |
---|---|---|
System.String | language | The source code language. |
System.String | value | The source code. |