RuleDataObjects

A collection of prefight rule data objects.

Go to Property Listing | Method Listing

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property	Type	Access	Description
length	Number	readonly	The number of objects in the collection.

Method Listing

RuleDataObject [] (index:Number)

Returns the RuleDataObject with the specified index.

Parameter	Type	Description
index	Number	The index.

RuleDataObject add (name:String, dataType:RuleDataType, dataValue:Array of Varies Boolean Booleans Booleans LongInteger LongIntegers LongIntegers Object Objects Real Reals Reals ShortInteger ShortIntegers ShortIntegers String Strings Arrays of Arrays of Strings Objects, withProperties:Object)

Add a new preflight rule data to a preflight profile rule.

Parameter	Type	Description
name	String	The name of the rule data to add
dataType	RuleDataType RuleDataType.BOOLEAN_DATA_TYPE RuleDataType.INTEGER_DATA_TYPE RuleDataType.LIST_DATA_TYPE RuleDataType.OBJECT_DATA_TYPE RuleDataType.REAL_DATA_TYPE RuleDataType.SHORT_INTEGER_DATA_TYPE RuleDataType.STRING_DATA_TYPE	The type of data
dataValue	Boolean Booleans Boolean LongInteger LongIntegers Object Objects Object Real Reals ShortInteger ShortIntegers String Array of Strings String Array of Arrays of Arrays of Strings	The value of data. Can accept: String, Real, Long Integer, Short Integer, Boolean, Object or Array of Strings, Reals, Long Integers, Short Integers, Booleans, Objects or Arrays of Array of Arrays of Array of Strings, Reals, Long Integers, Short Integers, Booleans or Objects.
withProperties	Object	Initial values for properties of the new RuleDataObject (Optional)

RuleDataObject anyItem ()

Returns any RuleDataObject in the collection.

Number count ()

Displays the number of elements in the RuleDataObject.

RuleDataObject everyItem ()

Returns every RuleDataObject in the collection.

RuleDataObject firstItem ()

Returns the first RuleDataObject in the collection.

RuleDataObject item (index:Varies LongInteger String)

Returns the RuleDataObject with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

The index or name. Can accept: Long Integer or String.

RuleDataObject itemByID (id:Number)

Returns the RuleDataObject with the specified ID.

Parameter	Type	Description
id	Number	The ID.

RuleDataObject itemByName (name:String)

Returns the RuleDataObject with the specified name.

Parameter	Type	Description
name	String	The name.

RuleDataObject itemByRange (from:Varies LongInteger RuleDataObject String, to:Varies LongInteger RuleDataObject String)

Returns the RuleDataObjects within the specified range.

Parameter	Type	Description
from	LongInteger RuleDataObject String	The RuleDataObject, index, or name at the beginning of the range. Can accept: RuleDataObject, Long Integer or String.
to	LongInteger RuleDataObject String	The RuleDataObject, index, or name at the end of the range. Can accept: RuleDataObject, Long Integer or String.

Parameter

Type

Description

from

LongInteger

RuleDataObject

String

The RuleDataObject, index, or name at the beginning of the range. Can accept: RuleDataObject, Long Integer or String.

LongInteger

RuleDataObject

String

The RuleDataObject, index, or name at the end of the range. Can accept: RuleDataObject, Long Integer or String.

RuleDataObject lastItem ()

Returns the last RuleDataObject in the collection.

RuleDataObject middleItem ()

Returns the middle RuleDataObject in the collection.

RuleDataObject nextItem (obj:RuleDataObject)

Returns the RuleDataObject whose index follows the specified RuleDataObject in the collection.

Parameter	Type	Description
obj	RuleDataObject	The RuleDataObject whose index comes before the desired RuleDataObject.

RuleDataObject previousItem (obj:RuleDataObject)

Returns the RuleDataObject with the index previous to the specified index.

Parameter	Type	Description
obj	RuleDataObject	The index of the RuleDataObject that follows the desired RuleDataObject.

String toSource ()

Generates a string which, if executed, will return the RuleDataObject.

Object of

PreflightRuleInstance.ruleDataObjects

PreflightProfileRule.ruleDataObjects