RecordRestriction Class

Defines a parameterized record restriction that can be applied to queries.

Inheritance Hierarchy

SystemObject
GSF.Data.ModelRecordRestriction

Namespace: GSF.Data.Model
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.257-beta+00aa2366fbb9ec75f636ebc7cfa610e3826a727c

Syntax

C++

JavaScript

Copy

public class RecordRestriction : IEquatable<RecordRestriction>

Public Class RecordRestriction
	Implements IEquatable(Of RecordRestriction)

public ref class RecordRestriction : IEquatable<RecordRestriction^>

type RecordRestriction = 
    class
        interface IEquatable<RecordRestriction>
    end

GSF.Data.Model.RecordRestriction = function();

Type.createClass(
	'GSF.Data.Model.RecordRestriction',
	null,
	IEquatable`1);

View Source

The RecordRestriction type exposes the following members.

Constructors

	Name	Description
	RecordRestriction	Creates a new parameterized RecordRestriction with the specified SQL filter expression and parameters.

Top

Properties

	Name	Description
	Item	Gets or sets Parameters field value for the specified index.

Top

Methods

	Name	Description
	Clone	Creates a deep copy of this record restriction.
	Clone(RecordRestriction)	Creates a deep copy of the source record restriction.
	CombineAnd	Combines two record restrictions with an AND condition.
	CombineOr	Combines two record restrictions with an OR condition.
	Equals(Object)	Determines whether the specified object is equal to the current object. (Overrides ObjectEquals(Object))
	Equals(RecordRestriction)	Indicates whether the current object is equal to another object of the same type.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Overrides ObjectGetHashCode)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Operators

	Name	Description
	Addition(RecordRestriction, RecordRestriction)	Combines two record restrictions with an AND condition.
	BitwiseAnd(RecordRestriction, RecordRestriction)	Combines two record restrictions with an AND condition.
	BitwiseOr(RecordRestriction, RecordRestriction)	Combines two record restrictions with an OR condition.
	Equality(RecordRestriction, RecordRestriction)	Compares to record restrictions for equality.
	(String to RecordRestriction)	Implicitly converts a String based filter expression into a RecordRestriction.
	Inequality(RecordRestriction, RecordRestriction)	Compares to record restrictions for inequality.

Top

Fields

	Name	Description
	FilterExpression	Defines filter SQL expression for restriction as a composite format string - does not include WHERE. When escaping is needed for field names, use standard ANSI quotes.
	Parameters	Defines restriction parameter values.

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Remarks

For versatility, values in the Parameters array are mutable, however, this makes the array vulnerable to unintended updates for long-lived instances. Consequently, the normal use-case of record restriction instances should be considered temporal. If an instance needs to be cached, consider use of the Clone function to reduce risk of unintended array updates.

Reference

GSF.Data.Model Namespace