DataObjectLoadOptions Class

Can be used to specify the details of an access modifier class. If an access modifier is specified it overrides an eventual access modifier specified on the data object type of the data objects being loaded. Can be null.

Determines whether only the newest (default) or all versions should be loaded.

Caching can be applied when no special objects are being loaded and when no property security is being applied.

Defines whether the tree structur must be composed during the load of DataObjects BuildTree does not affect the number of objects loaded from the database in the first place, but if there are holes in the tree structure, the missing objects are loaded in a second round. Objects loaded in the secund round are populated with limitted data. These object has the attribute IsMissingParent set to true and does not appear in the DataObjects collection.

Determines whether special objects are created during the load of DataObjects. If set to true, User objects are created for DataObjects of type User. If not set, all objects are loaded as DataObjects which saves performance.

If set, only object which allow child objects are loaded. USed in the tree structure to save performance.

Certain attributes on the filter is handled specially: * AcceptanceFlags and ActionStatus is only used by ProcessController.GetActivityManager() * RootNodeId is never used - the caller must translate it to the treenode load options.

Which fixed fields should be read? Only a subset of fixed fields can be controlled with this collection, others are always loaded. If the list is empty, none of the (applicable) fixed fields are populated. Use AddAllFixedFields to populate the collection in an easy way.

MaxObjects is ignore if Allversions=true. ForceMaxObjects overrides this.

Negative list of dataobject ID's. No objects with the provided ID's are loaded.

Positive list of dataobject ID's. Unless the list is empty, only objects with the provided ID's are loaded.

Index of the first object to be read. IndexFirst is 0-based.

Specifies if the ActiveActivities collection must be populated.

Specifies whether the Assignee information will be loaded for the activities (if any) that are loaded.

Specifies if process objects must be loaded for loaded activity objects.

Determines if child object information must be loaded must be loaded (does at least one child object allow child objects) The information does not respect security (having access to see those child objects) The result is stored in DataObject.ChildrenAllowsChildren.

If set to true, the value of DataExchangeConfigId on the loaded DataObjects will be populated.

Determines if file attachments shall be loaded.

Specifies if activity objects must be loaded for loaded process objects.

Specifies if target objects must be loaded for process objects.

Determines if information on who read the version object and when should be loaded.

Determines if object security must be loaded. If set, the DataObject.SecurityObject attribute will be populated.

Maximum number of objects to load. (If BuildTree=true we may load more objects) If MaxObjects = 0 all objects are loaded.

Only object which are not referred to by any object through the provided reference propertyies are loaded.

Specifies whether the access modifier specified in AccessModifierClassInfo should be overridden. An eventual access modifier specified on the data object type, of the data objects being loaded, is also overridden.

Determines whether dataobjects should be loaded even though the user doesn't have access to them.

Determines whether the filter (expressions) should be disregarded. Note: This option is primarily for the cache refresh metod in AppLogic.

Determines whether properties should be loaded even though the user doesn't have access to them.

Sets the following flags: - OverrideDataObjectSecurity - OverridePropertySecurity - OverrideAccessModifier

PropertyIds can be used to limit which properties are populated on the loaded data objects. Only loading a subset of properties can have a positive impact on performance. If the list is empty, all properties are populated (unless SkipProperties is true)

Only object which refers the provided data objects through a reference property are loaded.

Only object which are referred to by the provided data objects through a reference property are loaded.

Defines if a fulltext search is required.

If SearchString is defined only objects which match the search string is loaded.

Determines whether only short versions of the contents of the various value properties of datatype=text will be loaded. Loading the short versions improves performance.

If this option is set nothing will be loaded at all!

Determines whether locked objects are skipped. If set to true, READPAST is used as locking hint in the database. Used in for instance dataobjlst.aspx as it increases the throughput. It may cause objects to disappear from the list while being updated in another transaction. To be used with grat caution.

Skip the assignment of default values to the data objects

Skip objects with infinite date time values in the properties specified in the list. An infinite date time is a date time value where the year is 9999. Only the year part of the date time is checked.

If PropertyIds is empty and SkipProperties is true then no properties are populated at all on the loaded data objects.

Specifies that reference property values must not be populated, i.e. their displayname shall not be loaded. Can be used to save performance when many objects are loaded and where the display name of reference property values are not used. Population of reference property values also involves checking and removing any that are for invalid objects.

If set, only versions created after a certain date is loaded. Used when AllVersions=true.

If set, only versions created before a certain date is loaded. Used when AllVersions=true.

Contains the sort fields. If no fields are provided we sort on Data Object ID. FixedFields must be provided with a negated Id.

Can hold parameters to the custom sql filters applied in SqlFilters.

SqlFilters can be used to apply custom sql filtering to the data object query. Each filter is added like this: "[where|and] ([filter])". Using the SqlFilters requires knowledge of the construction of the data object query! SqlFilters should ONLY be used if none of the other available filters can be applied! Examples: - "do.number > 100" - "not exists (select 1 from sometable as st where st.doid = do.id)"

Levels of children to load under those object provided in TreeNodeIdList. TreeNodeChildren does only have effect of TreeNodeIdList contains some elements. All means all nodes on all leves under the provided objects None: No child objects are loaded. OneLevel: One level of children are loaded (the direct children) TwoLevels: Two levels of children are loaded (children and childrens children) ThreeLevels: Three levels of children are loaded.

Only load object which has the provided parents or children See also TreeNodes, TreeNodeChildren og TreeNodeParents.

Behaviour for loading objects in TreeNodeIdList. TreeNodeParents only has effect of TreeNodeIdList contains some elements. None: No parents to the objects in TreeNodeIdList are loaded. RootPath: Direct nodes on the path from the object in TreeNodeIdList to the ROOT are loaded. RootPathAndChildren: As RootPath, but immediate children to nodes are also loaded.

Load the objects as provided in TreeNodeIdList

Negative list of dataobject Type ID's. The types with the provided UID's will not be loaded.

Positive list of dataobject UID's. Unless the list is empty, only objects with the provided UID's are loaded.

Unresolved filter expressions are added using IDataObjectLoadOptionsBase.AddFilterExpression()

Add alll possible fixed fields to the load options

Add filter expression object to the collection

Assigns particular load options from a view. It is used in placed where DataObjects are loaded based on a view for display to the user. The method is not merged with AssignFromView since DataObjects sometimes are loaded based on a view without the need for all the normal view attributes.

Initialize and object from another load options object

Assigns all options based on the view definition. The parent attribute from the view can be overridden with the parentId parameter.

Returns true if security shall be overridden on the data load.

Sets all securyty override flags (DataObjectSecurity, AccessModifier and Property)

Sets the values of the MaxObjects and IndexFirst properties accordingly to load paginated data.

Sets the value of SearchString unless the provided value is empty and leaveIfEmpty=true.

Validates that the supplied attributes are not mutual exclusive. An exception can be raised. In particular cases the attributes are corrected.

The check for changes to the DataObjectType object can be skipped when running inside a loop.

Converts object to boolean.

Converts object to DateTime.

Converts object to integer.

States a list of sql filters. Sql filters are added to the "where" clause of the query used for loading data objects. Using sql filters requires knowledge of how the data object query is constructed and should be used with great caution.