Class Parameter

Represents data used as an input to or an output from a question or control construct.

Inheritance
System.Object
NotificationObject
IdentifiableBase
Parameter
Inherited Members
Algenta.Colectica.Model.NotificationObject.RaisePropertyChanged<T>(Expression<>)
Namespace: Algenta.Colectica.Model.Ddi
Assembly: Algenta.Colectica.Model.Ddi.dll
Syntax
public class Parameter : IdentifiableBase, IIdentifiable

Constructors

Parameter()

Initializes a new instance of the Parameter class.

Declaration
public Parameter()

Properties

Alias

Gets or sets the canonical symbol used to access this parameter in source code or expressions.

Declaration
public string Alias { get; set; }
Property Value
Type Description
System.String

DefaultValue

Gets or sets the default value of the parameter.

Declaration
public string DefaultValue { get; set; }
Property Value
Type Description
System.String

Description

Gets a description of the parameter.

Declaration
public MultilingualString Description { get; }
Property Value
Type Description
MultilingualString

IsArray

Gets or sets a value indicating whether multiple pieces of data are passed.

Declaration
public bool IsArray { get; set; }
Property Value
Type Description
System.Boolean

Name

Gets a descriptive name for the parameter. For the canonical symbol, use Alias.

Declaration
public MultilingualString Name { get; }
Property Value
Type Description
MultilingualString

ParameterType

Gets or sets whether the parameter is an input or an output.

Declaration
public InstrumentParameterType ParameterType { get; set; }
Property Value
Type Description
InstrumentParameterType

ValueRepresentation

Gets or sets the data type of the parameter.

Declaration
public ResponseDomain ValueRepresentation { get; set; }
Property Value
Type Description
ResponseDomain

Methods

Clone()

Clones this instance, with a new identifier

Declaration
public Parameter Clone()
Returns
Type Description
Parameter

A new instance with the same content.

GetChildren()

Gets the identifiers of the item's children.

Declaration
public virtual ChildItemCollection GetChildren()
Returns
Type Description
ChildItemCollection

The identifiers of the item's children.

GetReferenceableId()

Return an identifier triple for this "identifiable" parameter, using the default version (1)

Declaration
public IdentifierTriple GetReferenceableId()
Returns
Type Description
IdentifierTriple

an irdi that can be used for internal resolution

GetReferenceableId(Int64)

Return an identifier triple for this "identifiable" parameter, using a specified version

Declaration
public IdentifierTriple GetReferenceableId(long version)
Parameters
Type Name Description
System.Int64 version

version to include in complete irdi
Returns
Type Description
IdentifierTriple

an irdi that can be used for internal resolution

RemoveChild(IdentifierTriple)

Removes the specified child.

Declaration
public virtual 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.

ReplaceChild(IdentifierTriple, IVersionable)

Replaces the child with the specified identifier with the provided item.

Declaration
public virtual 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.

ToString()

Returns a that represents this instance.

Declaration
public override string ToString()
Returns
Type Description
System.String

A that represents this instance.

VersionOf(Parameter)

Returns true if the specified agency identifier and item identifier are the same as the ones in this instance.

Declaration
public bool VersionOf(Parameter b)
Parameters
Type Name Description
Parameter b
Returns
Type Description
System.Boolean

VersionOf(IdentifierTriple)

Returns true if the specified agency identifier and item identifier are the same as the ones in this instance.

Declaration
public bool VersionOf(IdentifierTriple b)
Parameters
Type Name Description
IdentifierTriple b
Returns
Type Description
System.Boolean

Extension Methods