ArchFactoryStates()

new ArchFactoryStates()

A factory instance that lets you add Architect states to flows. Do not attempt to create an instance of this class. Architect Scripting will create the factory instance as needed.

Extends

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchFactoryStates'.

static, readonly isArchFactoryStates :boolean

Returns true indicating that this is an ArchFactoryStates instance.

readonly logStr :string

A logging string for the Architect Factory State instance.

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

addState(archBaseFlow, nameopt, setAsStartingStateopt) → {ArchState}

This method will create and add a state to a flow.

Parameters:
Name Type Attributes Default Description
archBaseFlow ArchBaseFlowWorkflow

the flow where the state will be added.
name string <optional>

the name of the new state. If undefined, null or a blank string, a default name will be assigned by Architect Scripting to the new state.
setAsStartingState boolean <optional>
 false

whether or not the newly created state should be set as the startup object on the flow.
Returns:
ArchState

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: