AI OnAI Off

Class ChangeLogQueryInfo

Information about a change log item

Inheritance
System.Object
ChangeLogQueryInfo
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.ChangeLog
Assembly: EPiServer.dll
Version: 8.11.0
Syntax
public class ChangeLogQueryInfo

Constructors

ChangeLogQueryInfo()

Declaration
public ChangeLogQueryInfo()

Properties

Action

If set the query will be filtered on the Action property using this value. This property becomes immutable once this object instance has been used to read records from the change log as the same instance can be used to do paging and therefore must be consistent in subsequent reads.

Declaration
public virtual int? Action { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Category

If set the query will be filtered on the Category property using this value. This property becomes immutable once this object instance has been used to read records from the change log as the same instance can be used to do paging and therefore must be consistent in subsequent reads.

Declaration
public virtual int? Category { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

ChangedBy

If set the query will be filtered on the ChangedBy property using this value. This property becomes immutable once this object instance has been used to read records from the change log as the same instance can be used to do paging and therefore must be consistent in subsequent reads.

Declaration
public virtual string ChangedBy { get; set; }
Property Value
Type Description
System.String

Deleted

If set the query will be filtered on deleted property using this value. This property becomes immutable once this object instance has been used to read records from the change log as the same instance can be used to do paging and therefore must be consistent in subsequent reads.

Declaration
public virtual bool? Deleted { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

From

If set the query will be filtered on the ChangeDate property using this value. This property becomes immutable once this object instance has been used to read records from the change log as the same instance can be used to do paging and therefore must be consistent in subsequent reads.

Declaration
public virtual DateTime? From { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

LastReadFirstRowSeq

The sequence number of the first row read by the read query

Declaration
public virtual long LastReadFirstRowSeq { get; protected set; }
Property Value
Type Description
System.Int64

LastReadLastRowSeq

The sequence number of the last row read by the read query

Declaration
public virtual long LastReadLastRowSeq { get; protected set; }
Property Value
Type Description
System.Int64

MaxRecordsToReturn

The maximum number of records to return for each read

Declaration
public virtual int MaxRecordsToReturn { get; set; }
Property Value
Type Description
System.Int32

ReadOnly

The read only status of this object. If this instance contains state information from a previous read (the SetLastReadStateInfo(Int64, Int64) has been called) the the object will become read only.

Declaration
public virtual bool ReadOnly { get; protected set; }
Property Value
Type Description
System.Boolean

StartSequenceNumber

If set the query will be filtered on the SequenceNumber property using this value. This property becomes immutable once this object instance has been used to read records from the change log as the same instance can be used to do paging and therefore must be consistent in subsequent reads.

Declaration
public virtual long? StartSequenceNumber { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

To

If set the query will be filtered on the ChangeDate property using this value. This property becomes immutable once this object instance has been used to read records from the change log as the same instance can be used to do paging and therefore must be consistent in subsequent reads.

Declaration
public virtual DateTime? To { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

Methods

IsSameQuery(ChangeLogQueryInfo)

Compares the ChangeLogQueryInfo to determine if they represent the same query

Declaration
public virtual bool IsSameQuery(ChangeLogQueryInfo info)
Parameters
Type Name Description
ChangeLogQueryInfo info

A ChangeLogQueryInfo instance to compare
Returns
Type Description
System.Boolean 
true
if the queries are considered equal, otherwise 
false

Parse(String)

Parses the string passed and creates a new instance of a ChangeLogQueryInfo class.

Declaration
public static ChangeLogQueryInfo Parse(string s)
Parameters
Type Name Description
System.String s

A string representation of an ChangeLogQueryInfo instance. Such as string can be obtained from the ToString() method.
Returns
Type Description
ChangeLogQueryInfo

A ChangeLogQueryInfo instance

SetLastReadStateInfo(Int64, Int64)

Set state information from a read of the change log. It is this information which allows the same ChangeLogQueryInfo instance to be passed to a read method more than once in order to achieve paging

Declaration
public virtual void SetLastReadStateInfo(long firstRowSequenceNumber, long lastRowSequenceNumber)
Parameters
Type Name Description
System.Int64 firstRowSequenceNumber

The sequence number of the first row read by the query
System.Int64 lastRowSequenceNumber

The sequence number of the last row read by the query

ThrowIfReadOnly()

If the item is read only, an application exception will be thrown

Declaration
protected void ThrowIfReadOnly()
Exceptions
Type Condition
System.InvalidOperationException

The property is read only

ToString()

Writes a string which can later be parsed to Parse(String) to re-instantiate an object instance

Declaration
public override string ToString()
Returns
Type Description
System.String

A string representation of the object
Overrides
System.Object.ToString()

Extension Methods