ArchFilterClausePropertyValueEquals(propertyName, value, propertyMustExist)

new ArchFilterClausePropertyValueEquals(propertyName, value, propertyMustExist)

The Architect Scripting class that checks to see if a property value on an object is equal to a value. Equality checking is done using the JavaScript === operator when comparing to the value. Instances of this class will be automatically created by Architect Scripting when you call the addClausePropertyValueEquals method. Note: Do not attempt to create an instance of this class directly. Instances of this class will be created automatically by Architect Scripting as needed.

Parameters:
Name Type Description
propertyName string

the name of the property that contains the value you want to compare
value any

the value to compare against
propertyMustExist boolean

whether or not the property must exist on the object being checked when evaluating the clause
See:

Extends

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchFilterClausePropertyValueEquals'.

readonly isArchBaseFilterClause :boolean

Returns true indicating that this is an ArchBaseFilterClause instance.

Inherited From:

readonly isArchBaseFilterClausePropertyValue :boolean

Returns true indicating that this is an ArchBaseFilterClausePropertyValue instance.

Inherited From:

readonly isArchBaseFilterMatching :boolean

Returns true indicating that this is an ArchBaseObjectFilterCommon instance.

Inherited From:

readonly isArchFilterClausePropertyValueEquals :boolean

Returns true indicating that this is an ArchFilterClausePropertyValueEquals instance.

readonly value :string

Returns the property value that this filter clause will check.

Inherited From:

Methods

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
Inherited From: