Extends

• ArchBaseObject

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchTraverseHierarchyItem'.

readonly archBaseObject :ArchBaseObject

Returns the Architect Scripting object associated with this hierarchy item.

readonly hierarchyStr :string

Returns a string that represents the hierarchy of this item in the traverse stack. If you were traversing a flow that was just created in Scripting code, an example string could look like:

    __script_flow__1.tasksReusable[0].actions[5].outputs[1].actions[0]

This would mean that the object in this hierarchical item is from the first action of the second output of the sixth action for the first reusable task in the flow. One thing to note is that often times you'll see a guid as the first part of that string. It just so happens that for a created but not saved flow the identifier for it is not a guid.

readonly index :number

If this hierarchical item represents an item that is in an array for a property value, accessing this property will return the index of that item, otherwise nothing. The property name that is being accessed is available from the ArchTraverseHierarchyItem#propertyName property and the object that contains the property is accessible from the ArchTraverseHierarchyItem#archBaseObject property. An example of this would be when a hierarchical item is the first action from the actions property on a task. It would return a value of 0 in that case.

readonly isArchTraverseHierarchyItem :boolean

Returns true indicating that this is an ArchTraverseHierarchyItem instance.

readonly logStr :string

A string suitable for logging that contains information about hierarchy item.

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.

Inherited From:

• ArchBaseObject#logStrTypeOnly

readonly propertyName :string

Returns the property name associated with this hierarchical item. The property name refers to the property being referenced off of the ArchTraverseHierarchyItem#archBaseObject associated with this hierarchy item.

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:

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

Inherited From:

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

Inherited From:

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

Inherited From:

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

Inherited From:

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

Inherited From:

• ArchBaseObject#logWarning