Click or drag to resize

DataObjectIdLoadOptions Class

These load options are used when retrieving only the DataObject ID's
Inheritance Hierarchy
SystemObject
  Omada.OE.ModelDataObjectLoadOptionsBase
    Omada.OE.ModelDataObjectIdLoadOptions
      Omada.OE.ModelUserGroupIdLoadOptions
      Omada.OE.ModelUserIdLoadOptions

Namespace:  Omada.OE.Model
Assembly:  Omada.OE.Model (in Omada.OE.Model.dll) Version: 15.0.0.0
Syntax
C#
[SerializableAttribute]
public class DataObjectIdLoadOptions : DataObjectLoadOptionsBase

The DataObjectIdLoadOptions type exposes the following members.

Constructors
  NameDescription
Public methodDataObjectIdLoadOptions
Top
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 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 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 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 propertyMaxObjects
Specify the maximum number of DataObject ID's to retrieve
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 propertyOverrideSecurity
Sets the following flags: - OverrideDataObjectSecurity - OverridePropertySecurity - OverrideAccessModifier
(Inherited from DataObjectLoadOptionsBase.)
Public propertyParentIds (Inherited from DataObjectLoadOptionsBase.)
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 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 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.)
Top
Methods
  NameDescription
Public methodAddFilterExpression(UnresolvedFilterExpression)
Add filter expression object to the collection
(Inherited from DataObjectLoadOptionsBase.)
Public methodAddFilterExpression(String, ExpInnerOperator, Boolean, String) (Inherited from DataObjectLoadOptionsBase.)
Public methodAddFilterExpression(String, ExpInnerOperator, IEnumerableGuid, String) (Inherited from DataObjectLoadOptionsBase.)
Public methodAddFilterExpression(String, ExpInnerOperator, IEnumerableInt32, String) (Inherited from DataObjectLoadOptionsBase.)
Public methodAddFilterExpression(String, ExpInnerOperator, DateTime, String) (Inherited from DataObjectLoadOptionsBase.)
Public methodAddFilterExpression(String, ExpInnerOperator, Int32, String) (Inherited from DataObjectLoadOptionsBase.)
Public methodAddFilterExpression(String, ExpInnerOperator, String, String) (Inherited from DataObjectLoadOptionsBase.)
Public methodAssignFrom
Initialize and object from another load options object
(Inherited from DataObjectLoadOptionsBase.)
Public methodAssignFromView
(Inherited from DataObjectLoadOptionsBase.)
Protected methodgetOverrideSecurity
Returns true if both DataObjectSecurity and AccessModifier security overridden.
(Inherited from DataObjectLoadOptionsBase.)
Protected methodsetOverrideSecurity
Sets override on both DataObjectSecurity and AccessModifier security
(Inherited from DataObjectLoadOptionsBase.)
Public methodSetSearchString
Sets the value of SearchString unless the provided value is empty and leaveIfEmpty=true.
(Inherited from DataObjectLoadOptionsBase.)
Public methodValidateOptions
Validates that the supplied attributes are not mutual exclusive. An exception can be raised. In particular cases the attributes are corrected.
(Inherited from DataObjectLoadOptionsBase.)
Top
Fields
  NameDescription
Public fieldSkipCheckForTypeChanges
The check for changes to the DataObjectType object can be skipped when running inside a loop.
(Inherited from DataObjectLoadOptionsBase.)
Top
Extension Methods
  NameDescription
Public Extension MethodToBool
Converts object to boolean.
(Defined by ObjectExtensions.)
Public Extension MethodToDateTime
Converts object to DateTime.
(Defined by ObjectExtensions.)
Public Extension MethodToInt
Converts object to integer.
(Defined by ObjectExtensions.)
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