AccessEntityFilterTEntity Class |
Namespace: AGI.Foundation.Tracking
public class AccessEntityFilter<TEntity> : EntityFilter<TEntity> where TEntity : class, IEntityIdentifier, IEntityLastUpdate
The AccessEntityFilterTEntity type exposes the following members.
Name | Description | |
---|---|---|
AccessEntityFilterTEntity(AccessEntityFilterTEntity, CopyContext) | Initializes a new instance as a copy of an existing instance. | |
AccessEntityFilterTEntity(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.
| |
AccessEntityFilterTEntity(TransactionContext, EntityParameterTEntity, TransactionParameter, AccessQuery, EvaluatorGroup) |
Initializes a new instance with a specified Query.
| |
AccessEntityFilterTEntity(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.
|
Name | Description | |
---|---|---|
EntityParameter |
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.
| |
IsFrozen |
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.) | |
IsThreadSafe |
Gets a value indicating whether the methods on this instance are safe to call from
multiple threads simultaneously.
(Inherited from EntityFilterTEntity.) | |
MatchingEntities |
Gets the set of entities that match this filter.
(Inherited from EntityFilterTEntity.) | |
Query |
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 .
| |
TimeObserver |
Gets or sets the IServiceProvider that will be used to
evaluate the Query.
| |
TransactionParameter |
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.
|
Name | Description | |
---|---|---|
ApplyChanges |
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.
| |
BeginEntityMatching |
Indicates to the filter that the EntityFilterChainTEntity has begun
matching entities to filters as part of a RedistributeEntities
operation.
(Inherited from EntityFilterTEntity.) | |
CheckForSameDefinition(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).
| |
CheckForSameDefinition(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.) | |
CheckForSameDefinition(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).) | |
Clone |
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).) | |
ComputeCurrentDefinitionHashCode |
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.) | |
EndEntityMatching |
Indicates to the filter that the EntityFilterChainTEntity has finished
matching entities to filters as part of a RedistributeEntities
operation.
(Inherited from EntityFilterTEntity.) | |
EntityMatchingCleanup |
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.) | |
EntityMatchingSetup |
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).) | |
EnumerateDependencies |
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).) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
Freeze |
Freezes this object. Further attempts to modify it will result
in an ObjectFrozenException.
(Inherited from DefinitionalObject.) | |
FreezeAggregatedObjects |
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.) | |
GetDefinitionHashCode |
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
IsMatch |
Returns true if the provided entity fits the filter criteria.
(Overrides EntityFilterTEntityIsMatch(Transaction, TEntity).) | |
IsSameDefinition |
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.) | |
Match |
Checks an entity against this filter and adds it to the MatchingEntities collection
if it matches.
(Inherited from EntityFilterTEntity.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
ThrowIfFrozen |
Throws ObjectFrozenException if this object IsFrozen.
This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |