Click or drag to resize

DataObjectFilter Class

The class models a filter which is related to a number of objects like view and a counter DataObjectFilter is special comapred to other filters, as the class has a DB representation
Inheritance Hierarchy
SystemObject
  Omada.OE.ModelDataObjectFilter

Namespace:  Omada.OE.Model
Assembly:  Omada.OE.Model (in Omada.OE.Model.dll) Version: 15.0.0.0
Syntax
C#
[SerializableAttribute]
public class DataObjectFilter : ICloneable, 
	IObjectWithId, IObjectWithGuid, IObjectWithDataVersion, IObjectContainingDataObjectFilter

The DataObjectFilter type exposes the following members.

Constructors
  NameDescription
Public methodDataObjectFilter
Top
Properties
  NameDescription
Public propertyAcceptanceFlags
AcceptanceFlags is only used when the filter is applied on a list of workitems. AcceptanceFlags går på brugerens egen acceptance! Altså ikke aktivitetens samlede acceptance.
Public propertyActionStatus
ActionStatus is only used when the filter is applied on a list of workitems. It filters on WorkItemAction.
Public propertyAssigneeCurrentUser
AssigneeCurrentUser is only used on activities and processes. AssigneeCurrentUser is only used if AssigneeFilter is null. If AssigneeCurrentUser is true only activities which assignee group contains the active user will pass.
Public propertyAssigneeFilter
The AssigneeFilter is ued when loading Activities and Processes. The TypeIds attribute must contain only Activities or only Processes. Only activities which assignee group contains one or more of the provided users will pass the filter Process will only pass if at least on activity can pass the assignee filter. AssigneeFilter is null if no filter is provided. The AssigneeFilter is required to have its members loaded.
Public propertyAssigneeFilterType
Defines how the assignee filter is used. If the type is 'explicit' only activities which are explicitly assigned to the user passes the filter. If the type is 'implicit' only activities which is assigned to groups in which the user is member passes the filter,
Public propertyDataVersion
Public propertyDeletedStatus
Filter on whether the DataObject is deleted
Public propertyExpressions
Public propertyId
Internal ID of the filter
Public propertyMemberGroupId
MemberGroupId is only used if filtering is for exactly the 'Users' data object type. If specified only users, who are members of the group, are included.
Public propertyOwner
Denotes the type of object that owns the filter.
Public propertyProcessTemplateIds
Only load objects which are created from the provided process templates.
Public propertyReadStatus
Filter on whether the active user has read the DataObject. Note: a customer setting controls whether read-info is logged or not. If not then this filter should not be used.
Public propertyRequireActiveProcess
If set to true, only objects which are target object in an active process is loaded.
Public propertyRequireActiveWorkItem
If set to true, only data object which are target object in an active process is loaded and the active user must have an active workitem.
Public propertyRootNodeId
Public propertySecurityStatus
Filter on the security inheritance status
Public propertyStateFlags
StateFlags is used when loading Activities and Processes.
Public propertySystemStatus
Filter on the System attribute on DataObjects
Public propertyTargetTypeIds
Public propertyTemplateStatus
Filter on the template attribute on DataObjects
Public propertyTypeIds
When set, only objects of the given DataObjectTypes are loaded.
Public propertyUId
UID of the filter
Public propertyWorkItemDeletedStatus
Filter on whteher WorkItem is deleted
Top
Methods
  NameDescription
Public methodCanPass(DataObjectVersion)
Returns whether a given data object version can pass the filter. Not all filter options can be handled by the method! If an unhandled filter option is applied an error is thrown. Unhandled options are: RequireActiveProcess and RequireActiveWorkItem.
Public methodCanPass(DataObject, DataObjectTypes)
Public methodClone
Public methodContainsOnlyOneWorkflowRelatedType
returns true if TypeIds list contain exactly Activities or Processes
Public methodStatic memberContainsOnlyOneWorkflowRelatedType(IntegerList)
returns true if dataObjTypeIds list contain exactly Activities or Processes
Public methodContainsSpecialTypeFiltering
Returns true hvis filter rummer filtrering, som kun giver mening for objekter af de specielle typer.
Public methodStatic memberGetActivityStatesFromStateFlags
Public methodGetTypeNames
Public methodGetTypeObjects
Returns DataObjectType objects from the cache based on the type ID's in TypeIds
Public methodGetValidExpressionFields
Returns a collection of fields (properties and fixed fields) that are valid to be used in the filter's expressions.
Public methodGetValidExpressions
Returnerer de expressions som er valide.
Public methodResetAll
Nulstiller objektets id m.v. Metoden anvendes hvis man vil oprette et nyt filter (i db) som en kopi af et andet.
Public methodResetWorkflowRelatedValues
Method is used in DataObjectFilterController.SaveFilter(). Resets workflow related settings to their default values if the filter's types doesn't contain exactly processes or activities.
Public methodValidate
Validates that the filter is in a valid state - if not an exception is thrown.
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
See Also