abstract ArchBaseObjectFilterCommon()

new abstract ArchBaseObjectFilterCommon()

An Architect Scripting class that provides internal support for Architect filter related classes that support matching capabilities. Note: Do not attempt to create instances of this class directly. They will be created automatically as needed by Architect Scripting.

Extends

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchBaseObjectFilterCommon'.

readonly isArchBaseFilterMatching :boolean

Returns true indicating that this is an ArchBaseObjectFilterCommon instance.

readonly logStr :string

This is a string suitable for logging information about this object which is generated by the Architect Scripting object itself. Usually this contains stuff like the tracking ID, name, type information, etc. etc. This information will be used as the header for actual logging calls.

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

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:

isMatch(archBaseObjectToCheck) → {boolean}

This function returns whether or not the supplied ArchBaseObject instance is a match for the inheriting filter object type. For the ArchFilterClauseContainer class, which you'll note that ArchFilterObject inherits from too, if there are no filter clauses in them the isMatch handling will return true.

Parameters:
Name Type Description
archBaseObjectToCheck ArchBaseObject

the ArchBaseObject instance you wish to check to see if it's a match.
Returns:
boolean

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: