ArchFactoryDataTypes()

new ArchFactoryDataTypes()

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

Extends

Members

readonly displayTypeName :string

Returns the display type name string 'ArchFactoryDataTypes'.

readonly logStr :string

Returns a string suitable for logging.

Inherited From:

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

getOrCreateCustomJsonDataTypeAsync(archBaseFlow, customJsonNamespace, entityName, customJsonDataTypeSchemaType)

Returns the custom JSON data type that is associated with the given custom JSON namespace and entity name. If the data type does not exist within the flow, it will be created.

Parameters:
Name Type Description
archBaseFlow ArchBaseFlow

the flow where the data type will be created or retrieved.
customJsonNamespace string

the custom JSON namespace to use for creating the data type. Allowable values are: ArchEnums#CUSTOM_JSON_TYPE_NAMESPACES
entityName string

the name of the entity that is being referenced by the custom JSON namespace.
customJsonDataTypeSchemaType string

the custom JSON schema types to use for creating the data type. Allowable values are: ArchEnums#CUSTOM_JSON_SCHEMA_TYPES

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: