new ArchFilterClausePropertyCallback(propertyName, value, propertyMustExist)
The Architect Scripting class that lets you check the value of a property via. a callback function and return a boolean result indicating if the object should be considered a match for this clause or not. 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 |
Extends
Members
-
static, readonly displayTypeName :string
-
Returns the display type name string 'ArchFilterClausePropertyCallback'.
-
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.
-
readonly isArchBaseFilterMatching :boolean
-
Returns true indicating that this is an ArchBaseObjectFilterCommon instance.
- Inherited From:
-
readonly isArchFilterClausePropertyCallback :boolean
-
Returns true indicating that this is an ArchFilterClausePropertyCallback instance.
-
readonly value :string
-
Returns the callback function that this callback will use to check.
- Overrides:
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 thatArchFilterObject
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: