Extends

• ArchBaseObject

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchFlowInfoBasic'.

static, readonly isArchFlowInfoBasic :boolean

Returns true indicating that this is an ArchFlowInfo instance.

readonly id :string

The flow identifier

readonly logStr :string

A string suitable for logging that contains information about this flow info basic.

Overrides:

• ArchBaseObject#logStr

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.

Overrides:

• ArchBaseObject#logStrTypeOnly

readonly name :string

Gets name for the flow contained in this flow info instance.

readonly type :string

Returns the flow type associated with this flow info. The string values in ArchEnums#FLOW_TYPES lists valid values.

Methods

getFlowInfoAsync(callbackFunctionopt) → {Promise.<ArchFlowInfoBasic>}

Looks up the flow information from this flow info basic instance by the flow identifier.

Parameters:

Name	Type	Attributes	Description
callbackFunction	callbackArchFlowInfo	<optional>	the function to call back if successfully converted. The callback will be passed the looked up ArchFlowInfo instance.

Returns:

Promise.<ArchFlowInfoBasic>

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

Overrides:

• ArchBaseObject#isFilterMatch

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.

Overrides:

• ArchBaseObject#logError

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.

Overrides:

• ArchBaseObject#logErrorAndThrow

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.

Overrides:

• ArchBaseObject#logNote

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.

Overrides:

• ArchBaseObject#logNoteVerbose

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.

Overrides:

• ArchBaseObject#logWarning