Show / Hide Table of Contents

Class NSFindResults

Result carrier for the Find operation. It contains a set of column specifications, and a set of row, where each row contains the columns. The row set is the result of carrying out some search operation.

Syntax

Constructors

NSFindResults()

Initializes a new instance of the NSFindResults class.

Declaration
NSFindResults

Methods

GetArchiveColumns()

Result carrier for the Find operation. It contains a set of column specifications, and a set of row, where each row contains the columns. The row set is the result of carrying out some search operation.

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

Array of ColumnInfo column specifications.

Examples
NSFindResults thing;
NSArchiveColumnInfo[] archiveColumns = thing.GetArchiveColumns();

GetArchiveRows()

Result carrier for the Find operation. It contains a set of column specifications, and a set of row, where each row contains the columns. The row set is the result of carrying out some search operation.

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

Array of archive list items, i.e., the service layer carrier for archive rows. These are the find results, represented as archive rows.

Examples
NSFindResults thing;
NSArchiveListItem[] archiveRows = thing.GetArchiveRows();

GetRowCount()

Result carrier for the Find operation. It contains a set of column specifications, and a set of row, where each row contains the columns. The row set is the result of carrying out some search operation.

Declaration
Integer GetRowCount()
Returns
Type Description
Integer

Count of rows, independent of paging. If you order up page 1 with page size 50, the row count may still be 279, that being the number of rows that would have been returned in a paging-off situation.

Examples
NSFindResults thing;
Integer rowCount = thing.GetRowCount();

SetArchiveColumns(NSArchiveColumnInfo[])

Result carrier for the Find operation. It contains a set of column specifications, and a set of row, where each row contains the columns. The row set is the result of carrying out some search operation.

Declaration
Void SetArchiveColumns(NSArchiveColumnInfo[] archiveColumns)
Parameters
Type Name Description
archiveColumns

Array of ColumnInfo column specifications.

Returns
Type Description
NSArchiveColumnInfo[]
Examples
NSFindResults thing;
NSArchiveColumnInfo[] archiveColumns;
thing.SetArchiveColumns(archiveColumns);

SetArchiveRows(NSArchiveListItem[])

Result carrier for the Find operation. It contains a set of column specifications, and a set of row, where each row contains the columns. The row set is the result of carrying out some search operation.

Declaration
Void SetArchiveRows(NSArchiveListItem[] archiveRows)
Parameters
Type Name Description
NSArchiveListItem[] archiveRows

Array of archive list items, i.e., the service layer carrier for archive rows. These are the find results, represented as archive rows.

Returns
Type Description
Void
Examples
NSFindResults thing;
NSArchiveListItem[] archiveRows;
thing.SetArchiveRows(archiveRows);

SetRowCount(Integer)

Result carrier for the Find operation. It contains a set of column specifications, and a set of row, where each row contains the columns. The row set is the result of carrying out some search operation.

Declaration
Void SetRowCount(Integer rowCount)
Parameters
Type Name Description
Integer rowCount

Count of rows, independent of paging. If you order up page 1 with page size 50, the row count may still be 279, that being the number of rows that would have been returned in a paging-off situation.

Returns
Type Description
Void
Examples
NSFindResults thing;
Integer rowCount;
thing.SetRowCount(rowCount);
In This Article
  • Constructors
    • NSFindResults()
  • Methods
    • GetArchiveColumns()
    • GetArchiveRows()
    • GetRowCount()
    • SetArchiveColumns(NSArchiveColumnInfo[])
    • SetArchiveRows(NSArchiveListItem[])
    • SetRowCount(Integer)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top