Extends

• ArchBaseValueBasic

Members

static, readonly displayTypeName :string

Implements override support for the display type name string for this Architect Scripting object.

static isArchValueCurrency :boolean

static isCurrencyAmountOnly :boolean

readonly isCollection :boolean

Returns false indicating that this value is a singleton value and not a collection value.

Inherited From:

• ArchBaseValueSingleton#isCollection

readonly valueText :string

Returns a JavaScript string representing the value specified on this ArchBaseValueSingleton instance. If this value is an expression, it returns the expression text. If this value is a variable, it returns the variable text. If this value is a literal, it will return a string that represents the value. Overall this property is meant to be a quick and easy way to look at a "value" string but it is not meant to be some kind of fully inclusive description of this ArchBaseValueSingleton instance overall. For most values that inherit from this class, it's pretty obvious what to expect as the returned string but there are a couple worth mentioning:

ArchValueCurrency       - a string formatted with '<amount>|<code>" where code is an ISO 4217 string.
ArchValueDate           - a string formatted as 'YYYY-MM-DD' where YYYY is 4 digit year, MM is 2 digit month and DD is two digit day.
ArchValueDateTime       - an ISO 8601 formatted string.
ArchValueDuration       - an XSD formatted duration string.
ArchValueTime           - a string formatted as 'hh:mm:ss' where hh is 2 digit hour, mm is 2 digit minute and ss is 2 digit second.

While we don't guarantee it in Scripting because this isn't the same runtime function evaluation engine that flows use, when accessing this property on a singleton value will be very similar to calling the ToString function in expressions at runtime.

Inherited From:

• ArchBaseValueSingleton#valueText

Methods

setExpressionNotSet()

This method sets the expression of NOT_SET on this value.

Inherited From:

• ArchBaseValueSingleton#setExpressionNotSet

setLiteralAmountAndCode(amount, codeopt)

Sets the currency value to a literal from the supplied amount and optional ISO 4217 currency code.

Parameters:

Name	Type	Attributes	Description
amount	number		this value is assigned to the amount property on the currency value. It must be a JavaScript number that when converted to a string does not have e notation.
code	string	<optional>	this optional value is assigned to the code property on the currency value. If specified, it must be a valid ISO 4217 code. Currency codes are processed case insensitively. If the supplied value is undefined or null, the currency value will have a NOT_SET String value for the code property.