Click or drag to resize

AccessEntityFilterTEntity Class

Inheritance Hierarchy
SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.TrackingEntityFilterTEntity
      AGI.Foundation.TrackingAccessEntityFilterTEntity

Namespace:  AGI.Foundation.Tracking
Assembly:  AGI.Foundation.Tracking (in AGI.Foundation.Tracking.dll) Version: 19.5.402.0 (19.5.402.0)
Syntax
public class AccessEntityFilter<TEntity> : EntityFilter<TEntity>
where TEntity : class, IEntityIdentifier, IEntityLastUpdate

Type Parameters

TEntity
The type of entity.

The AccessEntityFilterTEntity type exposes the following members.

Constructors
  NameDescription
Public methodAccessEntityFilterTEntity(TransactionContext) Obsolete.
Initializes a new instance. The Query property must be set and then ApplyChanges(EvaluatorGroup) must be called before this filter can be used.
Protected methodAccessEntityFilterTEntity(AccessEntityFilterTEntity, CopyContext)
Initializes a new instance as a copy of an existing instance.
Public methodAccessEntityFilterTEntity(TransactionContext, AccessQuery, EvaluatorGroup) Obsolete.
Initializes a new instance with a specified Query.
Public methodAccessEntityFilterTEntity(TransactionContext, EntityParameterTEntity, TransactionParameter)
Initializes a new instance. The Query property must be set and then ApplyChanges(EvaluatorGroup) must be called before this filter can be used.
Public methodAccessEntityFilterTEntity(TransactionContext, AccessQuery, IServiceProvider, EvaluatorGroup) Obsolete.
Initializes a new instance with a specified Query and TimeObserver. The filter is ready to be used immediately after it is constructed.
Public methodAccessEntityFilterTEntity(TransactionContext, EntityParameterTEntity, TransactionParameter, AccessQuery, EvaluatorGroup)
Initializes a new instance with a specified Query.
Public methodAccessEntityFilterTEntity(TransactionContext, EntityParameterTEntity, TransactionParameter, AccessQuery, IServiceProvider, EvaluatorGroup)
Initializes a new instance with a specified Query and TimeObserver. The filter is ready to be used immediately after it is constructed.
Top
Properties
  NameDescription
Public propertyEntityParameter
Gets or sets the entity parameter placeholder in the Query. ApplyChanges(EvaluatorGroup) must be called after setting this property in order for the change to take effect.
Public propertyIsFrozen
Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so.
(Inherited from DefinitionalObject.)
Public propertyIsThreadSafe
Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.
(Inherited from EntityFilterTEntity.)
Public propertyMatchingEntities
Gets the set of entities that match this filter.
(Inherited from EntityFilterTEntity.)
Public propertyQuery
Gets or sets the AccessQuery. Only entities for which this query returns AccessExists will be matched by this filter. ApplyChanges(EvaluatorGroup) must be called after setting this property in order for the change to take effect. If this query is a composite query (such as AccessQueryAnd), it is usually necessary to have its TimeObserver property set to one of the participants in the query. If this query is an AccessConstraint, the TimeObserver property can be .
Public propertyTimeObserver
Gets or sets the IServiceProvider that will be used to evaluate the Query.
Public propertyTransactionParameter
Gets or sets the Transaction parameter placeholder in the Query. ApplyChanges(EvaluatorGroup) must be called after setting this property in order for the change to take effect.
Top
Methods
  NameDescription
Public methodApplyChanges
Applies the changes to this filter. This method must be called after setting the Query, TransactionParameter, or EntityParameter properties in order for the changes to take effect. It is also necessary to call this method after changing any of the objects referenced directly or indirectly by these properties. Changes will take effect the next time after calling this method that entities are redistributed within the filter chain with a call to RedistributeEntities.
Public methodBeginEntityMatching (Inherited from EntityFilterTEntity.)
Protected methodCheckForSameDefinition(AccessEntityFilterTEntity)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
Protected methodCheckForSameDefinition(DefinitionalObject)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from EntityFilterTEntity.)
Protected methodCheckForSameDefinition(EntityFilterTEntity)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Overrides EntityFilterTEntityCheckForSameDefinition(EntityFilterTEntity).)
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Protected methodComputeCurrentDefinitionHashCode
Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the CheckForSameDefinition(DefinitionalObject) method.
(Overrides EntityFilterTEntityComputeCurrentDefinitionHashCode.)
Public methodEndEntityMatching (Inherited from EntityFilterTEntity.)
Protected methodEntityMatchingCleanup
Allows the filter to perform any filter-specific cleanup at the end of entity matching. This method is called by EndEntityMatching(Transaction).
(Inherited from EntityFilterTEntity.)
Protected methodEntityMatchingSetup
Allows the filter to perform any filter-specific setup at the start of entity matching. This method is called by BeginEntityMatching(Transaction).
(Overrides EntityFilterTEntityEntityMatchingSetup(Transaction).)
Public methodEnumerateDependencies
Enumerates the dependencies of this object by calling EnumerateT(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.
(Overrides DefinitionalObjectEnumerateDependencies(DependencyEnumerator).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
Called by Freeze to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.
(Inherited from DefinitionalObject.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsMatch
Returns true if the provided entity fits the filter criteria.
(Overrides EntityFilterTEntityIsMatch(Transaction, TEntity).)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Public methodMatch
Checks an entity against this filter and adds it to the MatchingEntities collection if it matches.
(Inherited from EntityFilterTEntity.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also