Field

Code Sample:

var session = inrule.createRuleSession(); 
var entity = session.createEntity("Entity1"); 
var field = entity.getField("Field1");
var fieldName = field.getName(); // fieldName is "Field1";

Code Sample:

var session = inrule.createRuleSession(); 
var entity = session.createEntity("Entity1"); 
var field = entity.getField("Field1");
var fieldId = field.getElementId(); // fieldId is "Entity1:1/Field1";

Code Sample:

var session = inrule.createRuleSession(); 
var boundValue = {"FirstName": "John"};
var entity = session.createEntity("Entity1", boundValue); 
var field = entity.getField("FirstName");
var fieldValue = field.getValue(); // fieldValue is "John"

Parameters:

value

Type: object

The value you want to set the Field to. If the type of the value does not match the type

of the Field, implicit conversion will take be attempted.

Description:

Sets the Field's value

Code Sample:

var session = inrule.createRuleSession(); 
var boundValue = {"FirstName": "John"};
var entity = session.createEntity("Entity1", boundValue); 
var field = entity.getField("FirstName");
var fieldValue = field.getValue(); // fieldValue is "John"
field.setValue("Jane");
var fieldNewValue = field.getValue(); // fieldNewValue is "Jane"

Parameters:

fieldName

Type: string

The name of the Field to return

Description:

For Entity and Complex fields, returns a child Field from the Field instance

Code Sample:

var session = inrule.createRuleSession();
// Assume Person has a field "FirstName" and a 
field "Child" that is of type "Person"
var boundValue = // A method that returns a person, its child and grandchild
var entity = session.createEntity("Person", boundValue); 
var child = entity.getField("Child");
var grandchild = child.getField("Child");

Parameters:

collectionName

Type: string

The name of the Collection to return

Description:

For Entity and Complex fields, returns a child Collection from the Field instance

Code Sample:

var session = inrule.createRuleSession();
// Assume Person has a Field "FirstName" and 
a Collection "Children" that is of type "Person"
var boundValue = // A method that returns a person, its children
var entity = session.createEntity("Person", boundValue); 
var children = entity.getCollection("Children");

Code Sample:

var session = inrule.createRuleSession();
var entity1 = session.createEntity("Entity1"); 
// Assuming Entity1 has a Rule Set that marks "Field1" 
as Invalid session.applyRules(function(log){
// entity1.getField("Field1").isValid() returns False
});

Code Sample:

var session = inrule.createRuleSession(); 
var entity = session.createEntity("Entity1"); 
var field = entity.getField("Field1");
var displayName = field.metadata.displayName;