Table of Contents

Interface IJobVariable

Namespace
ArcanaDevelopment.adTempus.Shared
Assembly
ArcanaDevelopment.adTempus.Shared.dll

Interface implemented by job variables

public interface IJobVariable

Properties

AddToEnvironment

Indicates whether the variable is added to the environment

bool AddToEnvironment { get; set; }

Property Value

bool

BooleanValue

Gets or sets the Value as a boolean value.

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).

Caption

The caption to be used when prompting for a value for this variable

string Caption { get; set; }

Property Value

string

DateTimeValue

Gets or sets the Value as a DateTime.

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.

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.

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.

Description

Documentation to be shown to the user when editing this value

string Description { get; set; }

Property Value

string

ExecutionOverrideRule

Determines whether the variable can be overridden when a job using this variable is submitted for execution by a Job Execution Task, Job Control Action, or manually (on-demand)

[RequiredVersion(5, 0, 0, 0)]
JobVariableOverrideRule ExecutionOverrideRule { get; set; }

Property Value

JobVariableOverrideRule

HideValue

Specifies whether the value should be hidden from the user

bool HideValue { get; set; }

Property Value

bool

Remarks

When HideValue is true the user interface hides the value of the variable. Users with Edit permission for the owning object are able to reveal the value of the variable but other users cannot. The Job Detail Log masks the values for hidden variables

IntegerValue

Gets or sets the Value as an integer.

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.

Name

The name of the variable

string Name { get; set; }

Property Value

string

OverriddenVariable 

IJobVariable OverriddenVariable { get; }

Property Value

IJobVariable

OverrideRule

Determines whether the variable can be overridden at a lower level

[RequiredVersion(5, 0, 0, 0)]
JobVariableOverrideRule OverrideRule { get; set; }

Property Value

JobVariableOverrideRule

PropagateInheritedValue 

bool PropagateInheritedValue { get; set; }

Property Value

bool

StringValue

Gets or sets the Value as a string

string StringValue { get; set; }

Property Value

string

TimeValue

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

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

Extension ID of the custom UI for this variable

string UserInterfaceExtensionID { get; set; }

Property Value

string

Value

The value of the variable

string Value { get; set; }

Property Value

string

Remarks

All variable values are stored as strings but can be specified as specific data types using the VariableType and get/set using one of the specified Value properties.

See Also

ValueAsObject

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

object ValueAsObject { get; }

Property Value

object

VariableType

The data type of the variable

JobVariableType VariableType { get; set; }

Property Value

JobVariableType

Remarks

See remarks under Value

Methods

TrySet(JobVariableType, string)

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

bool TrySet(JobVariableType varType, string newValue)

Parameters

NameTypeDescription
varType JobVariableType

The new VariableType
newValue string

The new Value

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.