Class NSArchiveRestrictionInfo

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

Syntax

Constructors

NSArchiveRestrictionInfo()

Initializes a new instance of the NSArchiveRestrictionInfo class.

Introduced or updated in version: 7

Declaration

NSArchiveRestrictionInfo

Methods

GetColumnInfo()

Introduced or updated in version: 7

Declaration

NSArchiveColumnInfo GetColumnInfo()

Returns

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

Examples

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

GetDisplayValues()

Introduced or updated in version: 7

Declaration

String[] GetDisplayValues()

Returns

Type	Description
String[]	Display representation of values.

Remarks

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

Examples

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.

Introduced or updated in version: 7.5

Declaration

Integer GetInterOperator()

Returns

Type	Description
Integer	inter-restriction operator 0 = None; 1 = And; 2 = Or.

Remarks

Default for new ArchiveRestrictionInfo objects is And

Examples

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

GetInterParenthesis()

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

Introduced or updated in version: 7.5

Declaration

Integer GetInterParenthesis()

Returns

Type	Description
Integer

Remarks

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

Examples

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

GetIsActive()

Introduced or updated in version: 7.5

Declaration

Bool GetIsActive()

Returns

Type	Description
Bool	Is this restriction active?

Remarks

Inactive restrictions will not influence the generated query.

Examples

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

GetName()

Introduced or updated in version: 7

Declaration

String GetName()

Returns

Type	Description
String	The programmatic column name, including any required prefixes.

Examples

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

GetOperator()

Introduced or updated in version: 7

Declaration

String GetOperator()

Returns

Type	Description
String	The operator, such as =

Examples

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

GetParenthesis()

Introduced or updated in version: 7

Declaration

Integer GetParenthesis()

Returns

Type	Description
Integer

GetSubRestrictions()

Introduced or updated in version: 7

Declaration

NSArchiveRestrictionInfo[] GetSubRestrictions()

Returns

Type	Description
NSArchiveRestrictionInfo[]	Optional collection of sub criteria, usually null but set for Saint counter fields.

Examples

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

GetUniqueHash()

Introduced or updated in version: 7

Declaration

Integer GetUniqueHash()

Returns

Type	Description
Integer

Examples

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

GetValues()

Introduced or updated in version: 7

Declaration

String[] GetValues()

Returns

Type	Description
String[]	Values to test against.

Examples

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

SetColumnInfo(NSArchiveColumnInfo)

Introduced or updated in version: 7

Declaration

Void SetColumnInfo(NSArchiveColumnInfo columnInfo)

Parameters

Type	Name	Description
NSArchiveColumnInfo	columnInfo	Optional complete NSArchiveColumnInfo for this restriction; in that case, ColumnInfo.Name == this.Name will always be true.

Returns

Type	Description
Void

Examples

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

SetDisplayValues(String[])

Introduced or updated in version: 7

Declaration

Void SetDisplayValues(String[] displayValues)

Parameters

Type	Name	Description
String[]	displayValues	Display representation of values.

Returns

Type	Description
Void

Remarks

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

Examples

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.

Introduced or updated in version: 7.5

Declaration

Void SetInterOperator(Integer operator)

Parameters

Type	Name	Description
Integer	operator	inter-restriction operator 0 = None; 1 = And; 2 = Or.

Returns

Type	Description
Void

Remarks

Default for new ArchiveRestrictionInfo objects is And

Examples

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

SetInterParenthesis(Integer)

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

Introduced or updated in version: 7.5

Declaration

Void SetInterParenthesis(Integer interParenthesis)

Parameters

Type	Name	Description
Integer	interParenthesis

Returns

Type	Description
Void

Remarks

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

Examples

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

SetIsActive(Bool)

Activates or deactivates a restriction.

Introduced or updated in version: 7.5

Declaration

Void SetIsActive(Bool isActive)

Parameters

Type	Name	Description
Bool	isActive	Is this restriction active?

Returns

Type	Description
Void

Remarks

Inactive restrictions will not influence the generated query.

Examples

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

SetName(String)

Introduced or updated in version: 7

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	The programmatic column name, including any required prefixes.

Examples

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

SetOperator(String)

Introduced or updated in version: 7

Declaration

Void SetOperator(String operator)

Parameters

Type	Name	Description
String	operator	The operator, such as =

Returns

Type	Description
Void

Examples

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

SetParenthesis(Integer)

Introduced or updated in version: 7

Declaration

Void SetParenthesis(Integer p)

Parameters

Type	Name	Description
Integer	p

Returns

Type	Description
Void

SetSubRestrictions(NSArchiveRestrictionInfo[])

Introduced or updated in version: 7

Declaration

Void SetSubRestrictions(NSArchiveRestrictionInfo[] subRestrictions)

Parameters

Type	Name	Description
NSArchiveRestrictionInfo[]	subRestrictions	Optional collection of sub criteria, usually null but set for Saint counter fields.

Returns

Type	Description
Void

Examples

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

SetUniqueHash(Integer)

Introduced or updated in version: 7

Declaration

Void SetUniqueHash(Integer uniqueHash)

Parameters

Type	Name	Description
Integer	uniqueHash

Returns

Type	Description
Void

Examples

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

SetValues(String[])

Introduced or updated in version: 7

Declaration

Void SetValues(String[] values)

Parameters

Type	Name	Description
String[]	values	Values to test against.

Returns

Type	Description
Void

Examples

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