Extends

• ArchBaseFactory

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchFactoryFilters'.

static, readonly isArchFactoryFilters :boolean

Returns true indicating that this is an ArchFactoryFilters instance.

readonly logStr :string

A logging string for the Architect Factory Filters instance.

Overrides:

• ArchBaseFactory#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

Methods

createFilterObject(matchStyleopt) → {ArchFilterObject}

This method creates a new filter object.

Parameters:

Name	Type	Attributes	Description
matchStyle	string	<optional>	this specifies whether the new filter object should use logical and'ing or logical or'ing when processing match results of individual filter clauses or filter clause containers contained in this filter. If not specified, the default value is ArchEnums.FILTER_CONTAINER_OPERATORS.and. The string values in ArchEnums#FILTER_CONTAINER_OPERATORS lists valid operator values.

Returns:

ArchFilterObject

createFilterTraverseDefault(wantArchBaseValuesopt) → {ArchFilterObject}

This helper method will create a default filter that is configured to match objects that have an isArchBaseAction, isArchBaseFlow, isArchBaseMenu, isArchBaseMenuChoice, isArchBaseMultiActionContainer, isArchBaseVariable or optionally an isArchBaseValue property with a value of true. Loosely translated that means this filter will match any flow, action, menu, menu choice, variable, multi-action container ( i.e. action output, state, task ) and optionally value objects. This is done by creating a new filter, adding ArchFilterClausePropertyValueEquals filter clauses via. the ArchFilterClauseContainer#addClausePropertyValueEquals method for each of the "is" properties where the filter is set up to or the match results of the contained clauses. This method is called by the ArchBaseCoreObject#traverse method with the wantArchBaseValues parameter value set to true to supply a default filter to use if no filter is specified when calling traverse.

Parameters:

Name	Type	Attributes	Default	Description
wantArchBaseValues	boolean	<optional>	false	whether or not to include ArchBaseValue objects in the filter.

Returns:

ArchFilterObject

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