Class ArchiveRestrictionInfo

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for ArchiveRestrictionInfo. This class carries information about a restriction on the query of an archive provider

public class ArchiveRestrictionInfo

Inheritance

object ← ArchiveRestrictionInfo

Inherited Members

object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Constructors

ArchiveRestrictionInfo()

Default constructor - defaults any enum props to 0.

public ArchiveRestrictionInfo()

Properties

ColumnInfo

Optional complete ArchiveColumnInfo for this restriction; in that case, ColumnInfo.Name == this.Name will always be true

public virtual ArchiveColumnInfo ColumnInfo { get; set; }

Property Value

ArchiveColumnInfo

DisplayValues

Display representation of value(s) - list ID’s are decoded to display texts, other values are represented in a format suitable for decoding and display through the CultureDataFormatter.

public virtual string[] DisplayValues { get; set; }

Property Value

string[]

InterOperator

Get or set the inter-restriction operator that describes how this restriction is related to the next one in an array. Default for new ArchiveRestrictionInfo objects is And NULL if unknown enum value.

[JsonIgnore]
public InterRestrictionOperator? InterOperator { get; set; }

Property Value

InterRestrictionOperator?

InterOperator_String

Get or set the inter-restriction operator that describes how this restriction is related to the next one in an array. Default for new ArchiveRestrictionInfo objects is And Raw string enum value.

[JsonProperty("InterOperator")]
public string InterOperator_String { get; set; }

Property Value

string

InterParenthesis

Get or set the parenthesis (if any) associated with this restriction. Positive values indicate a number of opening parentheses (deepening nesting level), while negative numbers indicate closing parentheses. Zero means no change in nesting level (no parentheses).

public virtual int InterParenthesis { get; set; }

Property Value

int

IsActive

Is this restriction active? Inactive restrictions will not influence the generated query

public virtual bool IsActive { get; set; }

Property Value

bool

Name

The programmatic column name, including any required prefixes

public virtual string Name { get; set; }

Property Value

string

Operator

The operator, such as =, etc

public virtual string Operator { get; set; }

Property Value

string

SubRestrictions

Optional collection of sub criteria, usually null but set for Saint counter fields

public virtual ArchiveRestrictionInfo[] SubRestrictions { get; set; }

Property Value

ArchiveRestrictionInfo[]

UniqueHash

public virtual int UniqueHash { get; set; }

Property Value

int

Values

Value(s) to test against

public virtual string[] Values { get; set; }

Property Value

string[]

SuperOffice.WebApi.Data.ArchiveRestrictionInfo

Class ArchiveRestrictionInfo

Inheritance

Inherited Members

Constructors

ArchiveRestrictionInfo()

Properties

ColumnInfo

Property Value

DisplayValues

Property Value

InterOperator

Property Value

See Also

InterOperator_String

Property Value

See Also

InterParenthesis

Property Value

IsActive

Property Value

Name

Property Value

Operator

Property Value

SubRestrictions

Property Value

UniqueHash

Property Value

Values

Property Value

See Also

​ Class ArchiveRestrictionInfo

​Inheritance

​Inherited Members

​Constructors

​ ArchiveRestrictionInfo()

​Properties

​ ColumnInfo

​Property Value

​ DisplayValues

​Property Value

​ InterOperator

​Property Value

​See Also

​ InterOperator_String

​Property Value

​See Also

​ InterParenthesis

​Property Value

​ IsActive

​Property Value

​ Name

​Property Value

​ Operator

​Property Value

​ SubRestrictions

​Property Value

​ UniqueHash

​Property Value

​ Values

​Property Value

​See Also

Class ArchiveRestrictionInfo

Inheritance

Inherited Members

Constructors

ArchiveRestrictionInfo()

Properties

ColumnInfo

Property Value

DisplayValues

Property Value

InterOperator

Property Value

See Also

InterOperator_String

Property Value

See Also

InterParenthesis

Property Value

IsActive

Property Value

Name

Property Value

Operator

Property Value

SubRestrictions

Property Value

UniqueHash

Property Value

Values

Property Value

See Also