A collection of prefight rule data objects.
Go to Property Listing | Method Listing
add, count, item, itemByName, itemByID, itemByRange, firstItem, lastItem, middleItem, previousItem, nextItem, anyItem, everyItem, toSource, []
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
length |
readonly |
The number of objects in the collection. |
RuleDataObject [] (index:Number)
Returns the RuleDataObject with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
The index. |
RuleDataObject add (name:String, dataType:RuleDataType, dataValue:Varies, withProperties:Object)
Add a new preflight rule data to a preflight profile rule.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name of the rule data to add |
|
|
dataType |
RuleDataType.INTEGER_DATA_TYPE RuleDataType.SHORT_INTEGER_DATA_TYPE RuleDataType.REAL_DATA_TYPE RuleDataType.STRING_DATA_TYPE RuleDataType.BOOLEAN_DATA_TYPE RuleDataType.OBJECT_DATA_TYPE RuleDataType.LIST_DATA_TYPE |
The type of data |
|
dataValue |
Varies |
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 |
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)
Returns the RuleDataObject with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
Varies |
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 |
The ID. |
RuleDataObject itemByName (name:String)
Returns the RuleDataObject with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name. |
RuleDataObject itemByRange (from:Varies, to:Varies)
Returns the RuleDataObjects within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
Varies |
The RuleDataObject, index, or name at the beginning of the range. Can accept: RuleDataObject, Long Integer or String. |
|
to |
Varies |
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 |
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 |
The index of the RuleDataObject that follows the desired RuleDataObject. |
String toSource ()
Generates a string which, if executed, will return the RuleDataObject.