Class ActionActivity

Represents source code in a specified language to be executed as part of a survey Instrument.

Inheritance
object
NotificationObject
IdentifiableBase
VersionableBase
DescribableBase
ActivityBase
ActionActivity
Implements
Inherited Members
Namespace: Algenta.Colectica.Model.Ddi
Assembly: Algenta.Colectica.Model.Ddi.dll
Syntax
public class ActionActivity : ActivityBase, INotifyPropertyChanged, IVersionable, IDescribable, IBindable, IIdentifiable, IHasCustomFields, 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
string

ComputationType

Value for TypeOfComputationKey to denote a computation

Declaration
public static string ComputationType
Field Value
Type Description
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
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
string

EditCheckType

Value for TypeOfComputationKey to denote an edit check

Declaration
public static string EditCheckType
Field Value
Type Description
string

HardEditCheckEnforcementLevel

Hard edit check enforcement level

Declaration
public static string HardEditCheckEnforcementLevel
Field Value
Type Description
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<string, 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
string

SoftEditCheckEnforcementLevel

Soft edit check enforcement level

Declaration
public static string SoftEditCheckEnforcementLevel
Field Value
Type Description
string

TypeOfComputationKey

user attribute key for type of computation

Declaration
public static string TypeOfComputationKey
Field Value
Type Description
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 = "goto"
Field Value
Type Description
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
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
bool

IsComputation

Gets a value indicating whether this action represents a computation.

Declaration
public bool IsComputation { get; }
Property Value
Type Description
bool

IsEditCheck

Gets a value indicating whether this action represents an edit check instruction.

Declaration
public bool IsEditCheck { get; }
Property Value
Type Description
bool

IsGoto

Gets a value indicating whether this action represents a goto instruction.

Declaration
public bool IsGoto { get; }
Property Value
Type Description
bool

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
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
string language

The source code language.
Returns
Type Description
SourceCode

The source code for the language, if any exists; otherwise null.

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
string language

The source code language.
Returns
Type Description
bool

true if source code exists for the language; otherwise false.

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
int

The number of children removed from the item.
Overrides
Exceptions
Type Condition
ArgumentNullException

child

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
int

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
string language

The source code language.
string value

The source code.

WatchProperties()

Watch for property changed events

Declaration
protected override void WatchProperties()
Overrides

Implements

Extension Methods