entityLoad
9
3

Overview ColdFusion Open BlueDragon Lucee

Loads and returns an array of entities of the specified entityName.EntityLoad (entityName, filtercriteria [,unique] EntityLoad(entityName, filtercriteria, sortorder [, options])

Attributes

Name Required Type Default Description
9
entityName Yes String No Help Available
9
filtercriteria Yes String No Help Available
9
id Yes String No Help Available
3
idOrFilter No The primary key value of the entity that must be loaded or Key-value pair (Struct) of property names and values. If there are more than one key-value pair, then the AND operator is used.If specified, loads and returns an array of entities of the specified entity name that matches the filtercriteria.
3
name No Name of the entity to be loaded.
9
3
options No String No Help Available
9
sortorder No String No Help Available
9
unique No String No Help Available
3
uniqueOrOrder No when the second argument is a id then this argument defines the boolean "unique" otherwise it defines the order. - unique: If unique is set to true, then the entity is returned. If you are sure that only one record exists that matches this filtercriteria, then you can specify unique=true, so that a single entity is returned instead of an array. If you set unique=true and multiple records are returned, then an exception occurs. - order: String used to specify the sortorder of the entities that are returned.If specified, loads and returns an array of entities that satisfy the filtercriteria sorted as specified by the sortorder.