Class NSCriteriaInformation

Carrier for criteria information. It contains all the search criteria - that is, ArchiveRestrictionInfo - objects, including a column specification. In addition, it contains the same criteria expressed as an archive, with an array of ArchiveColumnInfo specifications and a set of ArchiveRow rows. The rows of the archive form a subset of the restriction array.

Constructors

NSCriteriaInformation()

Initializes a new instance of the NSCriteriaInformation class.

Declaration

NSCriteriaInformation

Methods

GetCriteriaArchiveColumns()

Declaration

NSArchiveColumnInfo[] GetCriteriaArchiveColumns()

Examples

NSCriteriaInformation thing;
NSArchiveColumnInfo[] criteriaArchiveColumns = thing.GetCriteriaArchiveColumns();

Returns

Type Description
NSArchiveColumnInfo[] Array of ColumnInfo column specifications.

GetCriteriaArchiveRows()

Declaration

NSArchiveListItem[] GetCriteriaArchiveRows()

Examples

NSCriteriaInformation thing;
NSArchiveListItem[] criteriaArchiveRows = thing.GetCriteriaArchiveRows();

Returns

Type Description
NSArchiveListItem[] Array of archive list items (the service layer carrier for archive rows).

GetRestrictionGroups()

Declaration

NSArchiveRestrictionGroup[] GetRestrictionGroups()

Examples

NSCriteriaInformation thing;
NSArchiveRestrictionGroup[] restrictionGroups = thing.GetRestrictionGroups();

Returns

Type Description
NSArchiveRestrictionGroup[] Array of restriction groups, including the default first group of restrictions.

GetRestrictions()

Declaration

NSArchiveRestrictionInfo[] GetRestrictions()

Examples

NSCriteriaInformation thing;
NSArchiveRestrictionInfo[] restrictions = thing.GetRestrictions();

Returns

Type Description
NSArchiveRestrictionInfo[] Array of NSArchiveRestrictionInfo restriction specifications (for the first group if there are more than one).

SetCriteriaArchiveColumns(NSArchiveColumnInfo[])

Declaration

Void SetCriteriaArchiveColumns(NSArchiveColumnInfo[] criteriaArchiveColumns)

Examples

NSCriteriaInformation thing;
NSArchiveColumnInfo[] criteriaArchiveColumns;
thing.SetCriteriaArchiveColumns(criteriaArchiveColumns);

Parameters

Type Name Description
criteriaArchiveColumns Array of ColumnInfo column specifications.

Returns

Type Description
Void

SetCriteriaArchiveRows(NSArchiveListItem[])

Declaration

Void SetCriteriaArchiveRows(NSArchiveListItem[] criteriaArchiveRows)

Examples

NSCriteriaInformation thing;
NSArchiveListItem[] criteriaArchiveRows;
thing.SetCriteriaArchiveRows(criteriaArchiveRows);

Parameters

Type Name Description
NSArchiveListItem[] criteriaArchiveRows Array of archive list items, i.e., the service layer carrier for archive rows.

Returns

Type Description
Void

SetRestrictionGroups(NSArchiveRestrictionGroup[])

Declaration

Void SetRestrictionGroups(NSArchiveRestrictionGroup[] restrictionGroups)

Examples

NSCriteriaInformation thing;
NSArchiveRestrictionGroup[] restrictionGroups;
thing.SetRestrictionGroups(restrictionGroups);

Parameters

Type Name Description
NSArchiveRestrictionGroup[] restrictionGroups Array of NSArchiveRestrictionGroup, including the default first group of restrictions.

Returns

Type Description
Void

SetRestrictions(NSArchiveRestrictionInfo[])

Declaration

Void SetRestrictions(NSArchiveRestrictionInfo[] restrictions)

Examples

NSCriteriaInformation thing;
NSArchiveRestrictionInfo[] restrictions;
thing.SetRestrictions(restrictions);

Parameters

Type Name Description
NSArchiveRestrictionInfo[] restrictions Array of NSArchiveRestrictionInfo restriction specifications (for the first group if there are more than one group.

Returns

Type Description
Void