Show / Hide Table of Contents

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.

Syntax

Constructors

NSCriteriaInformation()

Initializes a new instance of the NSCriteriaInformation class.

Declaration
NSCriteriaInformation

Methods

GetCriteriaArchiveColumns()

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.

Declaration
NSArchiveColumnInfo[] GetCriteriaArchiveColumns()
Returns
Type Description
NSArchiveColumnInfo[]

Array of ColumnInfo column specifications.

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

GetCriteriaArchiveRows()

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.

Declaration
NSArchiveListItem[] GetCriteriaArchiveRows()
Returns
Type Description
NSArchiveListItem[]

Array of archive list items (the service layer carrier for archive rows).

Remarks

These are the criteria, represented as archive rows.

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

GetRestrictionGroups()

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.

Declaration
NSArchiveRestrictionGroup[] GetRestrictionGroups()
Returns
Type Description
NSArchiveRestrictionGroup[]

Array of restriction groups, including the default first group of restrictions.

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

GetRestrictions()

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.

Declaration
NSArchiveRestrictionInfo[] GetRestrictions()
Returns
Type Description
NSArchiveRestrictionInfo[]

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

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

SetCriteriaArchiveColumns(NSArchiveColumnInfo[])

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.

Declaration
Void SetCriteriaArchiveColumns(NSArchiveColumnInfo[] criteriaArchiveColumns)
Parameters
Type Name Description
criteriaArchiveColumns

Array of ColumnInfo column specifications.

Returns
Type Description
Void
Examples
NSCriteriaInformation thing;
NSArchiveColumnInfo[] criteriaArchiveColumns;
thing.SetCriteriaArchiveColumns(criteriaArchiveColumns);

SetCriteriaArchiveRows(NSArchiveListItem[])

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.

Declaration
Void SetCriteriaArchiveRows(NSArchiveListItem[] 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
Remarks

These are the criteria, represented as archive rows.

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

SetRestrictionGroups(NSArchiveRestrictionGroup[])

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.

Declaration
Void SetRestrictionGroups(NSArchiveRestrictionGroup[] restrictionGroups)
Parameters
Type Name Description
NSArchiveRestrictionGroup[] restrictionGroups

Array of NSArchiveRestrictionGroup, including the default first group of restrictions.

Returns
Type Description
Void
Examples
NSCriteriaInformation thing;
NSArchiveRestrictionGroup[] restrictionGroups;
thing.SetRestrictionGroups(restrictionGroups);

SetRestrictions(NSArchiveRestrictionInfo[])

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.

Declaration
Void SetRestrictions(NSArchiveRestrictionInfo[] 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
Examples
NSCriteriaInformation thing;
NSArchiveRestrictionInfo[] restrictions;
thing.SetRestrictions(restrictions);
In This Article
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top