NSArchiveRestrictionInfo

Carries information about a restriction on the query of an archive provider.

Constructors

NSArchiveRestrictionInfo()

NSArchiveRestrictionInfo

Initializes a new instance of the NSArchiveRestrictionInfo class.

Methods

GetColumnInfo()

NSArchiveColumnInfo GetColumnInfo()

Returns: CRMScript.NetServer.NSArchiveColumnInfo - Optional complete NSArchiveColumnInfo for this restriction; in that case, ColumnInfo.Name == this.Name will always be true. Example:

NSArchiveRestrictionInfo thing;
NSArchiveColumnInfo columnInfo = thing.GetColumnInfo();

GetDisplayValues()

String[] GetDisplayValues()

Returns: CRMScript.Global.String[] - Display representation of values.

List ID’s are decoded to display texts, other values are represented in a format suitable for decoding and display through the CultureDataFormatter.

Example:

NSArchiveRestrictionInfo thing;
String[] displayValues = thing.GetDisplayValues();

GetInterOperator()

Gets inter-restriction operator that describes how this restriction is related to the next one in an array.

Integer GetInterOperator()

Returns: CRMScript.Global.Integer - inter-restriction operator 0 = None; 1 = And; 2 = Or.

Default for new ArchiveRestrictionInfo objects is And

Example:

NSArchiveRestrictionInfo thing;
Integer interOperator = thing.GetInterOperator();

GetInterParenthesis()

Gets the parenthesis (if any) associated with this restriction.

Integer GetInterParenthesis()

Returns: CRMScript.Global.Integer

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).

Example:

NSArchiveRestrictionInfo thing;
Integer interParenthesis = thing.GetInterParenthesis();

GetIsActive()

Bool GetIsActive()

Returns: CRMScript.Global.Bool - Is this restriction active?

Inactive restrictions will not influence the generated query.

Example:

NSArchiveRestrictionInfo thing;
Bool isActive = thing.GetIsActive();

GetName()

String GetName()

Returns: CRMScript.Global.String - The programmatic column name, including any required prefixes. Example:

NSArchiveRestrictionInfo thing;
String name = thing.GetName();

GetOperator()

String GetOperator()

Returns: CRMScript.Global.String - The operator, such as = Example:

NSArchiveRestrictionInfo thing;
String operator = thing.GetOperator();

GetParenthesis()

Integer GetParenthesis()

Returns: CRMScript.Global.Integer

GetSubRestrictions()

NSArchiveRestrictionInfo[] GetSubRestrictions()

Returns: CRMScript.NetServer.NSArchiveRestrictionInfo[] - Optional collection of sub criteria, usually null but set for Saint counter fields. Example:

NSArchiveRestrictionInfo thing;
NSArchiveRestrictionInfo[] subRestrictions = thing.GetSubRestrictions();

GetUniqueHash()

Integer GetUniqueHash()

Returns: CRMScript.Global.Integer Example:

NSArchiveRestrictionInfo thing;
Integer uniqueHash = thing.GetUniqueHash();

GetValues()

String[] GetValues()

Returns: CRMScript.Global.String[] - Values to test against. Example:

NSArchiveRestrictionInfo thing;
String[] values = thing.GetValues();

SetColumnInfo(NSArchiveColumnInfo)

Void SetColumnInfo(NSArchiveColumnInfo columnInfo)

Returns: CRMScript.Global.Void Example:

NSArchiveRestrictionInfo thing;
NSArchiveColumnInfo columnInfo;
thing.SetColumnInfo(columnInfo);

SetDisplayValues(String[])

Void SetDisplayValues(String[] displayValues)

Returns: CRMScript.Global.Void

List IDs are decoded to display texts, other values are represented in a format suitable for decoding and display through the CultureDataFormatter.

Example:

NSArchiveRestrictionInfo thing;
String[] displayValues;
thing.SetDisplayValues(displayValues);

SetInterOperator(Integer)

Gets inter-restriction operator that describes how this restriction is related to the next one in an array.

Void SetInterOperator(Integer operator)

Returns: CRMScript.Global.Void

Default for new ArchiveRestrictionInfo objects is And

Example:

NSArchiveRestrictionInfo thing;
Integer interOperator;
thing.SetInterOperator(interOperator);

SetInterParenthesis(Integer)

Gets the parenthesis (if any) associated with this restriction.

Void SetInterParenthesis(Integer interParenthesis)

Returns: CRMScript.Global.Void

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).

Example:

NSArchiveRestrictionInfo thing;
Integer interParenthesis;
thing.SetInterParenthesis(interParenthesis);

SetIsActive(Bool)

Activates or deactivates a restriction.

Void SetIsActive(Bool isActive)

Returns: CRMScript.Global.Void

Inactive restrictions will not influence the generated query.

Example:

NSArchiveRestrictionInfo thing;
Bool isActive;
thing.SetIsActive(isActive);

SetName(String)

Void SetName(String name)

Returns: CRMScript.Global.Void Example:

NSArchiveRestrictionInfo thing;
String name;
thing.SetName(name);

SetOperator(String)

Void SetOperator(String operator)

Returns: CRMScript.Global.Void Example:

NSArchiveRestrictionInfo thing;
String operator;
thing.SetOperator(operator);

SetParenthesis(Integer)

Void SetParenthesis(Integer p)

Returns: CRMScript.Global.Void

SetSubRestrictions(NSArchiveRestrictionInfo[])

Void SetSubRestrictions(NSArchiveRestrictionInfo[] subRestrictions)

Returns: CRMScript.Global.Void Example:

NSArchiveRestrictionInfo thing;
NSArchiveRestrictionInfo[] subRestrictions;
thing.SetSubRestrictions(subRestrictions);

SetUniqueHash(Integer)

Void SetUniqueHash(Integer uniqueHash)

Returns: CRMScript.Global.Void Example:

NSArchiveRestrictionInfo thing;
Integer uniqueHash;
thing.SetUniqueHash(uniqueHash);

SetValues(String[])

Void SetValues(String[] values)

Returns: CRMScript.Global.Void Example:

NSArchiveRestrictionInfo thing;
String[] values;
thing.SetValues(values);

​Constructors

​NSArchiveRestrictionInfo()

​Methods

​GetColumnInfo()

​GetDisplayValues()

​GetInterOperator()

​GetInterParenthesis()

​GetIsActive()

​GetName()

​GetOperator()

​GetParenthesis()

​GetSubRestrictions()

​GetUniqueHash()

​GetValues()

​SetColumnInfo(NSArchiveColumnInfo)

​SetDisplayValues(String[])

​SetInterOperator(Integer)

​SetInterParenthesis(Integer)

​SetIsActive(Bool)

​SetName(String)

​SetOperator(String)

​SetParenthesis(Integer)

​SetSubRestrictions(NSArchiveRestrictionInfo[])

​SetUniqueHash(Integer)

​SetValues(String[])

Constructors

NSArchiveRestrictionInfo()

Methods

GetColumnInfo()

GetDisplayValues()

GetInterOperator()

GetInterParenthesis()

GetIsActive()

GetName()

GetOperator()

GetParenthesis()

GetSubRestrictions()

GetUniqueHash()

GetValues()

SetColumnInfo(NSArchiveColumnInfo)

SetDisplayValues(String[])

SetInterOperator(Integer)

SetInterParenthesis(Integer)

SetIsActive(Bool)

SetName(String)

SetOperator(String)

SetParenthesis(Integer)

SetSubRestrictions(NSArchiveRestrictionInfo[])

SetUniqueHash(Integer)

SetValues(String[])