Interface IJobVariable
- Namespace
- ArcanaDevelopment.adTempus.Shared
- Assembly
- ArcanaDevelopment.adTempus.Shared.dll
public interface IJobVariable
Properties
AddToEnvironment
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
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.
Documentation
string Documentation { get; set; }
Property Value
- string
HideValue
bool HideValue { get; set; }
Property Value
- bool
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
string Name { get; set; }
Property Value
- string
StringValue
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
string UserInterfaceExtensionID { get; set; }
Property Value
- string
Value
string Value { get; set; }
Property Value
- string
ValueAsObject
Gets the Value as an object of the type specified by the VariableType.
object ValueAsObject { get; }
Property Value
- object
VariableType
JobVariableType VariableType { get; set; }
Property Value
Methods
TrySet(JobVariableType, string)
Tries to set the variable to the specified type and value.
bool TrySet(JobVariableType varType, string newValue)
Parameters
| Name | Type | Description |
|---|---|---|
varType |
JobVariableType | |
newValue |
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.