ArchVariableSettings(archBaseVariable)

ArchVariableSettings

new ArchVariableSettings(archBaseVariable)

This class reports meta data about Architect variable classes in Architect Scripting such as if the variable can be configured as an input or output. Since variables exist at a particular scope in a flow such as flow scoped, task scoped or state scoped the meta data reported for a variable can change. Note: Do not attempt to create instances of this class directly. They will be created automatically as needed by Architect Scripting.

Parameters:
Name Type Description
archBaseVariable ArchBaseVariable

An Architect base variable instance.

Extends

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchVariableSettings'.

readonly canSetIsInput :boolean

Returns whether or not you can set a boolean value on the ArchBaseVariable#isInput property for the variable.

readonly canSetIsOutput :boolean

Returns whether or not you can set a boolean value on the ArchBaseVariable#isOutput property for the variable.

readonly logStr :string

A string suitable for logging that contains information about this value settings object.

Overrides:

readonly logStrTypeOnly :string

This is a string suitable for logging information about this object where it's just the object's type. This is normally used when logging errors that occur in constructor parameter checking because the scripting object isn't set up and the normal logging str contents wouldn't be set up.

Inherited From:

Methods

isFilterMatch(archFilterObject) → {boolean}

Returns whether or not this Architect Scripting object is a match for the supplied ArchFilterObject instance.

Parameters:
Name Type Description
archFilterObject ArchFilterObject

the object filter to use to determine if it's a match.
Returns:
boolean
Inherited From:

logError(errorStr)

Logs an error to the logging service with a log header from this object's logStr property value when ArchLogging#logErrors is true.

Parameters:
Name Type Description
errorStr string

the error string to log.
Inherited From:

logErrorAndThrow(errorStr)

Logs an error to the logging service with a log header from this object's logStr property value when ArchLogging#logErrors is true and then throws the string in the errorStr parameter.

Parameters:
Name Type Description
errorStr string

the error string to log. This should be a non-blank string.
Throws:
  • Throws the submitted error string.
Inherited From:

logNote(noteStr)

Logs a note to the logging service with a log header from this object's logStr property value when ArchLogging#logNotes is true.

Parameters:
Name Type Description
noteStr string

the note string to log. This should be a non-blank string.
Inherited From:

logNoteVerbose(noteStr)

Logs a note to the logging service with a log header from this object's logStr property value when ArchLogging#logNotesVerbose is true.

Parameters:
Name Type Description
noteStr string

the note string to log. This should be a non-blank string.
Inherited From:

logWarning(warningStr)

Logs a warning to the logging service with a log header from this object's logStr property value when ArchLogging#logWarnings is true.

Parameters:
Name Type Description
warningStr string

the warning string to log. This should be a non-blank string.
Inherited From: