Table of Contents

Class JobVariable

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll
public sealed class JobVariable : ADTObject, IJobVariable
Inheritance
object
JobVariable
Implements

Properties

AddToEnvironment

public bool AddToEnvironment { get; set; }

Property Value

bool

BooleanValue

Gets or sets the value as a boolean value.

public bool? BooleanValue { get; set; }

Property Value

bool?

Remarks

If the value is set using this property, the VariableType is changed to JobVariableType.Boolean. This property returns null if the variable has no value, or if the value cannot be converted to a boolean. adTempus stores boolean values as "1" (true) or "0" (false).

CID

The Class ID for the object

[IgnoreDataMember]
public override ClassID CID { get; }

Property Value

ClassID

Remarks

Obsolete. Use ClassID instead.

Caption

public string Caption { get; set; }

Property Value

string

ClassKeyName

The key name for the class.

public override string ClassKeyName { get; }

Property Value

string

Remarks

This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.

DateTimeValue

Gets or sets the value as a DateTime.

public DateTime? DateTimeValue { get; set; }

Property Value

DateTime?

Remarks

If the value is set using this property, the VariableType is changed to JobVariableType.DateTime. This property returns null if the variable has no value, or if the value cannot be converted to a DateTime. adTempus stores DateTime values in the format "yyyy-MM-dd HH:mm:ss.fff"

DateValue

Gets or sets the value as a DateTime containing only a date.

public DateTime? DateValue { get; set; }

Property Value

DateTime?

Remarks

If the value is set using this property, the VariableType is changed to JobVariableType.Date. This property returns null if the variable has no value, or if the value cannot be converted to a DateTime. adTempus stores DateTime values in the format "yyyy-MM-dd"

DecimalValue

Gets or sets the value as a decimal.

public decimal? DecimalValue { get; set; }

Property Value

decimal?

Remarks

If the value is set using this property, the VariableType is changed to JobVariableType.Decimal. This property returns null if the variable has no value, or if the value cannot be converted to a decimal.

Documentation

public string Documentation { get; set; }

Property Value

string

ExtendedDescription

public override string ExtendedDescription { get; }

Property Value

string

HideValue

public bool HideValue { get; set; }

Property Value

bool

IntegerValue

Gets or sets the value as an integer.

public int? IntegerValue { get; set; }

Property Value

int?

Remarks

If the value is set using this property, the VariableType is changed to JobVariableType.Integer. This property returns null if the variable has no value, or if the value cannot be converted to an integer.

IsDependent

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

Name

public string Name { get; set; }

Property Value

string

StringValue

public string StringValue { get; set; }

Property Value

string

TimeValue

Gets or sets the value as a DateTime value that stores only the time.

public DateTime? TimeValue { get; set; }

Property Value

DateTime?

Remarks

If the value is set using this property, the VariableType is changed to JobVariableType.Time. This property returns null if the variable has no value, or if the value cannot be converted to a DateTime. adTempus stores DateTime values in the format "HH:mm:ss.fff"

UserInterfaceExtensionID

public string UserInterfaceExtensionID { get; set; }

Property Value

string

Value

public string Value { get; set; }

Property Value

string

ValueAsObject

Gets the Value as an object of the type specified by the VariableType.

public object ValueAsObject { get; }

Property Value

object

VariableType

public JobVariableType VariableType { get; set; }

Property Value

JobVariableType

Methods

FindOwningObject()

Get the owner of this object based on relationships.

protected override ADTObject FindOwningObject()

Returns

ADTObject

The owning object, or null if the object is not owned by another object or the owner has not been set.

GetObjectDescription()

Gets a description of the object's key settings.

protected override string GetObjectDescription()

Returns

string

Remarks

This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.

See Also

HideFieldValueInTextOutput(string)

Suppress hidden values in Object Configuration Reports and Dataset Projections.

protected override bool HideFieldValueInTextOutput(string fieldName)

Parameters

NameTypeDescription
fieldName string

Returns

bool

TrySet(JobVariableType, string)

Tries to set the variable to the specified type and value.

public bool TrySet(JobVariableType varType, string value)

Parameters

NameTypeDescription
varType JobVariableType
value string

Returns

bool

Remarks

TrySet attempts to convert the provided string value to the type specified by varType. If this succeeds, the VariableType and Value are updated and the method returns True. Otherwise the variable is not updated and the method returns false.

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

Inherited Members