Click or drag to resize

DataObjectLoadOptions Properties

The DataObjectLoadOptions type exposes the following members.

Properties
  NameDescription
Public propertyAccessModifierClassInfo
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.
(Inherited from DataObjectLoadOptionsBase.)
Public propertyAllVersions
Determines whether only the newest (default) or all versions should be loaded.
(Inherited from DataObjectLoadOptionsBase.)
Public propertyApplyCaching
Caching can be applied when no special objects are being loaded and when no property security is being applied.
Public propertyBuildTree
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.
Public propertyCreateSpecialDataObjects
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.
(Inherited from DataObjectLoadOptionsBase.)
Public propertyDataObjectIds (Inherited from DataObjectLoadOptionsBase.)
Public propertyDataObjectTypeIds (Inherited from DataObjectLoadOptionsBase.)
Public propertyDataObjectUIds (Inherited from DataObjectLoadOptionsBase.)
Public propertyExcludeDataObjectIds (Inherited from DataObjectLoadOptionsBase.)
Public propertyExcludeObjectsWithoutChildPossibility
If set, only object which allow child objects are loaded. USed in the tree structure to save performance.
Public propertyFilter
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.
(Inherited from DataObjectLoadOptionsBase.)
Public propertyFilterExpressions (Inherited from DataObjectLoadOptionsBase.)
Public propertyFixedFields
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.
Public propertyForceMaxObjects
MaxObjects is ignore if Allversions=true. ForceMaxObjects overrides this.
Public propertyIdNegList
Negative list of dataobject ID's. No objects with the provided ID's are loaded.
(Inherited from DataObjectLoadOptionsBase.)
Public propertyIdPosList
Positive list of dataobject ID's. Unless the list is empty, only objects with the provided ID's are loaded.
(Inherited from DataObjectLoadOptionsBase.)
Public propertyIndexFirst
Index of the first object to be read. IndexFirst is 0-based.
Public propertyLoadActiveActivityObjects
Specifies if the ActiveActivities collection must be populated.
Public propertyLoadActivityAssignees
Specifies whether the Assignee information will be loaded for the activities (if any) that are loaded.
Public propertyLoadActivityForms
Public propertyLoadActivityProcessObjects
Specifies if process objects must be loaded for loaded activity objects.
Public propertyLoadChildrenAllowsChildrenInfo
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.
Public propertyLoadDataExchangeConfigId
If set to true, the value of DataExchangeConfigId on the loaded DataObjects will be populated.
Public propertyLoadFileAttachments
Determines if file attachments shall be loaded.
Public propertyLoadProcessActivityObjects
Specifies if activity objects must be loaded for loaded process objects.
Public propertyLoadProcessTargetObjects
Specifies if target objects must be loaded for process objects.
Public propertyLoadReadInfo
Determines if information on who read the version object and when should be loaded.
Public propertyLoadReferences Obsolete.
Public propertyLoadSecurity
Determines if object security must be loaded. If set, the DataObject.SecurityObject attribute will be populated.
Public propertyMaxObjects
Maximum number of objects to load. (If BuildTree=true we may load more objects) If MaxObjects = 0 all objects are loaded.
Public propertyMustBeReferredByDataObjectIds (Inherited from DataObjectLoadOptionsBase.)
Public propertyMustHaveReferenceToDataObjectIds (Inherited from DataObjectLoadOptionsBase.)
Public propertyNotReferredThroughRefPropertyIdList
Only object which are not referred to by any object through the provided reference propertyies are loaded.
(Inherited from DataObjectLoadOptionsBase.)
Public propertyOverrideAccessModifier
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.
(Inherited from DataObjectLoadOptionsBase.)
Public propertyOverrideDataObjectSecurity
Determines whether dataobjects should be loaded even though the user doesn't have access to them.
(Inherited from DataObjectLoadOptionsBase.)
Public propertyOverrideFilter
Determines whether the filter (expressions) should be disregarded. Note: This option is primarily for the cache refresh metod in AppLogic.
(Inherited from DataObjectLoadOptionsBase.)
Public propertyOverridePropertySecurity
Determines whether properties should be loaded even though the user doesn't have access to them.
Public propertyOverrideSecurity
Sets the following flags: - OverrideDataObjectSecurity - OverridePropertySecurity - OverrideAccessModifier
(Inherited from DataObjectLoadOptionsBase.)
Public propertyParentIds (Inherited from DataObjectLoadOptionsBase.)
Public propertyPropertyIds
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)
Public propertyReferredObjectIdList
Only object which refers the provided data objects through a reference property are loaded.
(Inherited from DataObjectLoadOptionsBase.)
Public propertyReferringObjectIdList
Only object which are referred to by the provided data objects through a reference property are loaded.
(Inherited from DataObjectLoadOptionsBase.)
Public propertySearchFullTextIndex
Defines if a fulltext search is required.
(Inherited from DataObjectLoadOptionsBase.)
Public propertySearchString
If SearchString is defined only objects which match the search string is loaded.
(Inherited from DataObjectLoadOptionsBase.)
Public propertyShortTextVersions
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.
(Inherited from DataObjectLoadOptionsBase.)
Public propertySkipAllObjects
If this option is set nothing will be loaded at all!
(Inherited from DataObjectLoadOptionsBase.)
Public propertySkipDBLockedObjects Obsolete.
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.
(Inherited from DataObjectLoadOptionsBase.)
Public propertySkipDefaultValues
Skip the assignment of default values to the data objects
Public propertySkipObjectsWithInfiniteDateTimeValues
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.
(Inherited from DataObjectLoadOptionsBase.)
Public propertySkipProperties
If PropertyIds is empty and SkipProperties is true then no properties are populated at all on the loaded data objects.
Public propertySkipReferencePropertyPopulation
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.
Public propertySkipVersionsCreatedAfter
If set, only versions created after a certain date is loaded. Used when AllVersions=true.
Public propertySkipVersionsCreatedBefore
If set, only versions created before a certain date is loaded. Used when AllVersions=true.
Public propertySortFields
Contains the sort fields. If no fields are provided we sort on Data Object ID. FixedFields must be provided with a negated Id.
Public propertySqlFilterParameters
Can hold parameters to the custom sql filters applied in SqlFilters.
(Inherited from DataObjectLoadOptionsBase.)
Public propertySqlFilters
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)"
(Inherited from DataObjectLoadOptionsBase.)
Public propertyTemplateStatus (Inherited from DataObjectLoadOptionsBase.)
Public propertyTreeNodeChildren
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.
(Inherited from DataObjectLoadOptionsBase.)
Public propertyTreeNodeIdList
Only load object which has the provided parents or children See also TreeNodes, TreeNodeChildren og TreeNodeParents.
(Inherited from DataObjectLoadOptionsBase.)
Public propertyTreeNodeParents
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.
(Inherited from DataObjectLoadOptionsBase.)
Public propertyTreeNodes
Load the objects as provided in TreeNodeIdList
(Inherited from DataObjectLoadOptionsBase.)
Public propertyTypeIdNegList
Negative list of dataobject Type ID's. The types with the provided UID's will not be loaded.
(Inherited from DataObjectLoadOptionsBase.)
Public propertyUIdPosList
Positive list of dataobject UID's. Unless the list is empty, only objects with the provided UID's are loaded.
(Inherited from DataObjectLoadOptionsBase.)
Public propertyUnresolvedFilterExpressions
Unresolved filter expressions are added using IDataObjectLoadOptionsBase.AddFilterExpression()
(Inherited from DataObjectLoadOptionsBase.)
Public propertyUseClassicLoadMethod Obsolete.
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate propertyCode exampleIDataObjectLoadOptionsBaseSqlFilters
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.
(Inherited from DataObjectLoadOptionsBase.)
Top
See Also