Class NSFindAgent

Find functions.

Syntax

Examples

NSFindAgent agent;
agent.callMethod(arg1, arg2);

Constructors

NSFindAgent()

Find functions.

Declaration

NSFindAgent

Examples

NSFindAgent agent;
agent.callMethod(arg1, arg2);

Methods

CreateRestrictionGroup(String,String,String,String)

Creates a restriction group, initialized with next rank etc.

Declaration

NSArchiveRestrictionGroup CreateRestrictionGroup(String storageType, String providerName, String storageKey, String context)

Parameters

Type	Name	Description
String	storageType
String	providerName
String	storageKey
String	context

Returns

Type	Description
NSArchiveRestrictionGroup

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
String context;
NSArchiveRestrictionGroup res = agent.CreateRestrictionGroup(storageType, providerName, storageKey, context);

DeleteRestrictionGroup(String,String,String,Integer,String)

Creates a restriction group, initialized with next rank etc.

Declaration

Void DeleteRestrictionGroup(String storageType, String providerName, String storageKey, Integer rank, String context)

Parameters

Type	Name	Description
String	storageType
String	providerName
String	storageKey
Integer	rank
String	context

Returns

Type	Description
Void

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
Integer rank;
String context;
agent.DeleteRestrictionGroup(storageType, providerName, storageKey, rank, context);

Find(String,String,String,Integer,Integer)

Executes a Find operation and return a page of results.

Declaration

NSFindResults Find(String storageType, String providerName, String storageKey, Integer pageSize, Integer pageNumber)

Parameters

Type	Name	Description
String	storageType
String	providerName
String	storageKey
Integer	pageSize
Integer	pageNumber

Returns

Type	Description
NSFindResults

Remarks

The other variants of the Find method allow you greater control over the individual aspects of the process.

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
Integer pageSize;
Integer pageNumber;
NSFindResults res = agent.Find(storageType, providerName, storageKey, pageSize, pageNumber);

FindFromRestrictions(NSArchiveRestrictionInfo[],String,Integer,Integer)

Executes a Find operation and return a page of results.

Declaration

NSFindResults FindFromRestrictions(NSArchiveRestrictionInfo[] restrictions, String providerName, Integer pageSize, Integer pageNumber)

Parameters

Type	Name	Description
NSArchiveRestrictionInfo[]	restrictions	Array of restrictions specifying the search. Each restriction must match a column of the given archive provider, and that column must have its CanRestrictBy property set to true.
String	providerName	Name of archive provider that is to execute the search and return the result columns/rows
Integer	pageSize	Size of result set pages
Integer	pageNumber	Result set page to return, 0 is the first page. When a call returns no rows, no further pages are available. Negative page numbers are interpreted as number of rows to skip.

Returns

Type	Description
NSFindResults

Remarks

The criteria for the Find are passed in directly, not fetched by a restriction storage provider. The columns of the result are calculated based on the restriction.

Examples

NSFindAgent agent;
NSArchiveRestrictionInfo[] restrictions;
String providerName;
Integer pageSize;
Integer pageNumber;
NSFindResults res = agent.FindFromRestrictions(restrictions, providerName, pageSize, pageNumber);

FindFromRestrictions2(String,String,Integer,Integer)

Executes a Find operation and return a page of results.

Declaration

NSFindResults FindFromRestrictions2(String restrictions, String providerName, Integer pageSize, Integer pageNumber)

Parameters

Type	Name	Description
String	restrictions	String of restrictions specifying the search. e.g. "name='SuperOffice'" Each restriction must match a column of the given archive provider, and that column must have its CanRestrictBy property set to true.
String	providerName	Name of archive provider that is to execute the search and return the result columns/rows
Integer	pageSize	Size of result set pages
Integer	pageNumber	Result set page to return, 0 is the first page. When a call returns no rows, no further pages are available. Negative page numbers are interpreted as number of rows to skip.

Returns

Type	Description
NSFindResults

Remarks

The criteria for the Find are passed in directly, not fetched by a restriction storage provider. The columns of the result are calculated based on the restriction.

Examples

NSFindAgent agent;
String restrictions;
String providerName;
Integer pageSize;
Integer pageNumber;
NSFindResults res = agent.FindFromRestrictions2(restrictions, providerName, pageSize, pageNumber);

FindFromRestrictionsColumns(NSArchiveRestrictionInfo[],String,String[],Integer,Integer)

Executes a Find operation and return a page of results.

Declaration

NSFindResults FindFromRestrictionsColumns(NSArchiveRestrictionInfo[] restrictions, String providerName, String[] desiredColumns, Integer pageSize, Integer pageNumber)

Parameters

Type	Name	Description
NSArchiveRestrictionInfo[]	restrictions	Array of restrictions specifying the search. Each restriction must match a column of the given archive provider, and that column must have its CanRestrictBy property set to true.
String	providerName	Name of archive provider that is to execute the search and return the result columns/rows
String[]	desiredColumns	Array of column names desired for the result. Each name must match a column offered by the given archive provider.
Integer	pageSize	Size of result set pages
Integer	pageNumber	Result set page to return, 0 is the first page. When a call returns no rows, no further pages are available. Negative page numbers are interpreted as number of rows to skip.

Returns

Type	Description
NSFindResults

Remarks

The criteria for the Find are passed in directly, not fetched by a restriction storage provider.The desired columns of the result set are also passed in directly.The orderby information is calculated by the system.Use the GetCriteriaInformation and GetDefaultDesiredColumns service methods to let the system calculate these values, if you want to use or modify them.n

Examples

NSFindAgent agent;
NSArchiveRestrictionInfo[] restrictions;
String providerName;
String[] desiredColumns;
Integer pageSize;
Integer pageNumber;
NSFindResults res = agent.FindFromRestrictionsColumns(restrictions, providerName, desiredColumns, pageSize, pageNumber);

FindFromRestrictionsColumns2(String,String,String,Integer,Integer)

Execute a Find operation and return a page of results.

Declaration

NSFindResults FindFromRestrictionsColumns2(String restrictions, String providerName, String desiredColumns, Integer pageSize, Integer pageNumber)

Parameters

Type	Name	Description
String	restrictions	String of restrictions specifying the search. e.g. "name='SuperOffice'" Each restriction must match a column of the given archive provider, and that column must have its CanRestrictBy property set to true.
String	providerName	Name of archive provider that is to execute the search and return the result columns/rows
String[]	desiredColumns	Array of column names desired for the result. Each name must match a column offered by the given archive provider.
Integer	pageSize	Size of result set pages
Integer	pageNumber	Result set page to return, 0 is the first page. When a call returns no rows, no further pages are available. Negative page numbers are interpreted as number of rows to skip.

Returns

Type	Description
NSFindResults

Remarks

Examples

NSFindAgent agent;
String restrictions;
String providerName;
String desiredColumns;
Integer pageSize;
Integer pageNumber;
NSFindResults res = agent.FindFromRestrictionsColumns2(restrictions, providerName, desiredColumns, pageSize, pageNumber);

FindFromRestrictionsColumnsOrderBy(String,String[],Integer,Integer)

Executes a Find operation and return a page of results.

Declaration

NSFindResults FindFromRestrictionsColumnsOrderBy(NSArchiveRestrictionInfo[] restrictions, String providerName, String[] desiredColumns, NSArchiveOrderByInfo[] orderBy, Integer pageSize, Integer pageNumber)

Parameters

Type	Name	Description
String	restrictions	String of restrictions specifying the search. e.g. "name='SuperOffice'" Each restriction must match a column of the given archive provider, and that column must have its CanRestrictBy property set to true.
String[]	desiredColumns	Array of column names desired for the result. Each name must match a column offered by the given archive provider.
Integer	pageSize	Size of result set pages
Integer	pageNumber	Result set page to return, 0 is the first page. When a call returns no rows, no further pages are available. Negative page numbers are interpreted as number of rows to skip.

Returns

Type	Description
NSFindResults

Remarks

The criteria for the Find are passed in directly, not fetched by a restriction storage provider.

The desired columns of the result set are also passed in directly.

The orderby information is also passed in directly.Use the GetCriteriaInformation, GetDefaultDesiredColumns and GetDefaultOrderBy service methods to let the system calculate these values, if you want to use or modify them.

Examples

NSFindAgent agent;
NSArchiveRestrictionInfo[] restrictions;
String providerName;
String[] desiredColumns;
NSArchiveOrderByInfo[] orderBy;
Integer pageSize;
Integer pageNumber;
NSFindResults res = agent.FindFromRestrictionsColumnsOrderBy(restrictions, providerName, desiredColumns, orderBy, pageSize, pageNumber);

FindFromRestrictionsColumnsOrderBy2(String,String,String,String,Integer,Integer)

Executes a Find operation and return a page of results.

Declaration

NSFindResults FindFromRestrictionsColumnsOrderBy2(String restrictions, String providerName, String desiredColumns, String orderBy, Integer pageSize, Integer pageNumber)

Parameters

Type	Name	Description
String	restrictions
String	providerName	Name of archive provider that is to execute the search and return the result columns/rows
String[]	desiredColumns	Array of column names desired for the result. Each name must match a column offered by the given archive provider.
String	orderBy	String of order by specifications. If it is null or empty, the row order is unspecified, database dependent, and might not be the same from call to call, depending on query execution plans. The unspecified order will generally not vary within pages of the same query.
Integer	pageSize	Size of result set pages
Integer	pageNumber	Result set page to return, 0 is the first page. When a call returns no rows, no further pages are available. Negative page numbers are interpreted as number of rows to skip.

Returns

Type	Description
NSFindResults

Remarks

The criteria for the Find are passed in directly, not fetched by a restriction storage provider.

The desired columns of the result set are also passed in directly.

Examples

NSFindAgent agent;
String restrictions;
String providerName;
String desiredColumns;
String orderBy;
Integer pageSize;
Integer pageNumber;
NSFindResults res = agent.FindFromRestrictionsColumnsOrderBy2(restrictions, providerName, desiredColumns, orderBy, pageSize, pageNumber);

FindOrderBy(String,String,String,Integer,Integer)

Executes a Find operation and return a page of results.

Declaration

NSFindResults FindOrderBy(String storageType, String providerName, String storageKey, Integer pageSize, Integer pageNumber, NSArchiveOrderByInfo[] orderBy)

Parameters

Type	Name	Description
String	storageType
String	providerName	Name of archive provider that is to execute the search and return the result columns/rows
String	storageKey
Integer	pageSize	Size of result set pages
Integer	pageNumber	Result set page to return, 0 is the first page. When a call returns no rows, no further pages are available. Negative page numbers are interpreted as number of rows to skip.

Returns

Type	Description
NSFindResults

Remarks

The criteria for the Find are fetched from the restriction storage provider according to the given parameters. The columns of the result are calculated based on the restriction. The orderby parameter is used for sorting the results.The other variants of the Find method allow you greater control over the individual aspects of the process.

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
Integer pageSize;
Integer pageNumber;
NSArchiveOrderByInfo[] orderBy;
NSFindResults res = agent.FindOrderBy(storageType, providerName, storageKey, pageSize, pageNumber, orderBy);

FindOrderBy2(String,String,String,Integer,Integer,String)

Executes a Find operation and return a page of results.

Declaration

NSFindResults FindOrderBy2(String storageType, String providerName, String storageKey, Integer pageSize, Integer pageNumber, String orderBy)

Parameters

Type	Name	Description
String	storageType
String	providerName	Name of archive provider that is to execute the search and return the result columns/rows
String	storageKey
Integer	pageSize	Size of result set pages
Integer	pageNumber	Result set page to return, 0 is the first page. When a call returns no rows, no further pages are available. Negative page numbers are interpreted as number of rows to skip.
String	orderBy	String of order by specifications. If it is null or empty, the row order is unspecified, database dependent, and might not be the same from call to call, depending on query execution plans. The unspecified order will generally not vary within pages of the same query.

Returns

Type	Description
NSFindResults

Remarks

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
Integer pageSize;
Integer pageNumber;
String orderBy;
NSFindResults res = agent.FindOrderBy2(storageType, providerName, storageKey, pageSize, pageNumber, orderBy);

FindWithColumns(String,String,String,String[],Integer,Integer)

Executes a Find operation and return a page of results.

Declaration

NSFindResults FindWithColumns(String storageType, String providerName, String storageKey, String[] desiredColumns, Integer pageSize, Integer pageNumber, NSArchiveOrderByInfo[] orderBy)

Parameters

Type	Name	Description
String	storageType
String	providerName	Name of archive provider that is to execute the search and return the result columns/rows
String[]	desiredColumns
String	storageKey
Integer	pageSize	Size of result set pages
Integer	pageNumber	Result set page to return, 0 is the first page. When a call returns no rows, no further pages are available. Negative page numbers are interpreted as number of rows to skip.

Returns

Type	Description
NSFindResults

Remarks

The criteria for the Find are fetched from the restriction storage provider according to the given parameters.

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
String[] desiredColumns;
Integer pageSize;
Integer pageNumber;
NSArchiveOrderByInfo[] orderBy;
NSFindResults res = agent.FindWithColumns(storageType, providerName, storageKey, desiredColumns, pageSize, pageNumber, orderBy);

FindWithExtraRestrictions(String,String,String,NSArchiveRestrictionInfo[],NSArchiveOrderByInfo[],String[],Integer,Integer)

Execute a Find operation and return a page of results.

Declaration

NSFindResults FindWithExtraRestrictions(String storageType, String providerName, String storageKey, NSArchiveRestrictionInfo[] extraRestrictions, NSArchiveOrderByInfo[] orderBy, String[] desiredColumns, Integer pageSize, Integer pageNumber)

Parameters

Type	Name	Description
String	storageType
String	providerName	Name of archive provider that is to execute the search and return the result columns/rows
String	storageKey
NSArchiveRestrictionInfo[]	extraRestrictions	Array of restrictions specifying the search. Each restriction must match a column of the given archive provider, and that column must have its CanRestrictBy property set to true.
NSArchiveOrderByInfo[]	orderBy	order by specifications. If it is null or empty, the row order is unspecified, database dependent, and might not be the same from call to call, depending on query execution plans. The unspecified order will generally not vary within pages of the same query.
String[]	desiredColumns
Integer	pageSize	Size of result set pages
Integer	pageNumber	Result set page to return, 0 is the first page. When a call returns no rows, no further pages are available. Negative page numbers are interpreted as number of rows to skip.

Returns

Type	Description
NSFindResults

Remarks

The criteria for the Find are fetched from the restriction storage provider according to the given parameters. In addition an extra set of restrictions can be added to the search. These restrictions will not be saved, they are only valid for the current search. Extra restrictions will override restrictions with the same key already stored on the storagekey.

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
NSArchiveRestrictionInfo[] extraRestrictions;
NSArchiveOrderByInfo[] orderBy;
String[] desiredColumns;
Integer pageSize;
Integer pageNumber;
NSFindResults res = agent.FindWithExtraRestrictions(storageType, providerName, storageKey, extraRestrictions, orderBy, desiredColumns, pageSize, pageNumber);

FindWithExtraRestrictions2(String,String,String,String,String,String,Integer,Integer)

Executes a Find operation and return a page of results.

Declaration

NSFindResults FindWithExtraRestrictions2(String storageType, String providerName, String storageKey, String extraRestrictions, String orderBy, String desiredColumns, Integer pageSize, Integer pageNumber)

Parameters

Type	Name	Description
String	storageType
String	providerName
String	storageKey
String	extraRestrictions
String	orderBy
String	desiredColumns
Integer	pageSize
Integer	pageNumber

Returns

Type	Description
NSFindResults

Remarks

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
String extraRestrictions;
String orderBy;
String desiredColumns;
Integer pageSize;
Integer pageNumber;
NSFindResults res = agent.FindWithExtraRestrictions2(storageType, providerName, storageKey, extraRestrictions, orderBy, desiredColumns, pageSize, pageNumber);

GetAvailableRestrictionColumns(String,String)

Gets a list of the column names corresponding to available restrictions for a certain archive provider and restriction storage provider. Such columns have CanRestrict set to true, and are supported by the given restriction storage provider.

Declaration

String[] GetAvailableRestrictionColumns(String storageType, String providerName)

Parameters

Type	Name	Description
String	storageType
String	providerName

Returns

Type	Description
String[]	list of the column names corresponding to available restrictions for a certain archive provider.

Examples

NSFindAgent agent;
String storageType;
String providerName;
String[] res = agent.GetAvailableRestrictionColumns(storageType, providerName);

GetCriteriaInformation(String,String,String,String[])

Gets criteria information from a set of saved criteria. The result contains the restrictions in two forms: fully populated NSArchiveRestrictionInfo objects, used to display details and for saving changes; and as a list suitable for an Archive control

Declaration

NSCriteriaInformation GetCriteriaInformation(String storageType, String providerName, String storageKey, String[] staticColumns)

Parameters

Type	Name	Description
String	storageType
String	providerName
String	storageKey
String[]	staticColumns

Returns

Type	Description
NSCriteriaInformation

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
String[] staticColumns;
NSCriteriaInformation res = agent.GetCriteriaInformation(storageType, providerName, storageKey, staticColumns);

GetCriteriaInformationWithContext(String,String,String,String[],String)

Declaration

NSCriteriaInformation GetCriteriaInformationWithContext(String storageType, String providerName, String storageKey, String[] staticColumns, String context)

Parameters

Type	Name	Description
String	storageType
String	providerName
String	storageKey
String[]	staticColumns
String	context

Returns

Type	Description
NSCriteriaInformation

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
String[] staticColumns;
String context;
NSCriteriaInformation res = agent.GetCriteriaInformationWithContext(storageType, providerName, storageKey, staticColumns, context);

GetDefaultDesiredColumns(String,String,String)

Calculates the default desired columns, i.e., the result columns for a given search. The search is defined by a storage type, provider name and storage key, which are used to fetch the corresponding restrictions from the database (in the same way as Find does). If you want to specify the restriction directly, use the GetDefaultDesiredColumnsFromRestrictions method instead. This is the algorithm that is used by the Find service method.

Declaration

NSArchiveColumnInfo[] GetDefaultDesiredColumns(String storageType, String providerName, String storageKey)

Parameters

Type	Name	Description
String	storageType
String	providerName
String	storageKey

Returns

Type	Description
NSArchiveColumnInfo[]

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
NSArchiveColumnInfo[] res = agent.GetDefaultDesiredColumns(storageType, providerName, storageKey);

GetDefaultDesiredColumnsFromRestrictions(String,NSArchiveRestrictionInfo[])

Calculate the default desired columns, i.e., the result columns for a given search. The search is defined by a provider name and a set of restrictions. This is the algorithm that is used by the Find service method.

Declaration

NSArchiveColumnInfo[] GetDefaultDesiredColumnsFromRestrictions(String providerName, NSArchiveRestrictionInfo[] restrictions)

Parameters

Type	Name	Description
String	providerName
NSArchiveRestrictionInfo[]	restrictions

Returns

Type	Description
NSArchiveColumnInfo[]

Examples

NSFindAgent agent;
String providerName;
NSArchiveRestrictionInfo[] restrictions;
NSArchiveColumnInfo[] res = agent.GetDefaultDesiredColumnsFromRestrictions(providerName, restrictions);

GetDefaultDesiredColumnsFromRestrictions2(String,String)

Declaration

NSArchiveColumnInfo[] GetDefaultDesiredColumnsFromRestrictions2(String providerName, String restrictions)

Parameters

Type	Name	Description
String	providerName
String	restrictions

Returns

Type	Description
NSArchiveColumnInfo[]

Examples

NSFindAgent agent;
String providerName;
String restrictions;
NSArchiveColumnInfo[] res = agent.GetDefaultDesiredColumnsFromRestrictions2(providerName, restrictions);

GetDefaultOrderBy(String,String,String)

Calculates the default orderby columns for a given provider and a search. The search is specified by a storage type, provider name and storage key, and is fetched from the database. Default desired columns are then calculated for the search, and those columns are then used as the basis for calculating an order by. If you want to specify the desired columns directly, use the GetDefaultOrderByFromDesiredColumns method instead. This is the same algorithm that is used by the Find service method.

Declaration

NSArchiveOrderByInfo[] GetDefaultOrderBy(String storageType, String providerName, String storageKey)

Parameters

Type	Name	Description
String	storageType
String	providerName
String	storageKey

Returns

Type	Description
NSArchiveOrderByInfo[]

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
NSArchiveOrderByInfo[] res = agent.GetDefaultOrderBy(storageType, providerName, storageKey);

GetDefaultOrderByFromDesiredColumns(String,String[])

Calculate the default orderby columns for a given provider and a set of desired columns. This is the same algorithm that is used by the Find service method.

Declaration

NSArchiveOrderByInfo[] GetDefaultOrderByFromDesiredColumns(String providerName, String[] desiredColumns)

Parameters

Type	Name	Description
String	providerName
String[]	desiredColumns

Returns

Type	Description
NSArchiveOrderByInfo[]

Examples

NSFindAgent agent;
String providerName;
String[] desiredColumns;
NSArchiveOrderByInfo[] res = agent.GetDefaultOrderByFromDesiredColumns(providerName, desiredColumns);

GetRestrictionGroup(String,String,String,Integer,String)

Return the restriction group with given rank or a blank carrier.

Declaration

NSArchiveRestrictionGroup GetRestrictionGroup(String storageType, String providerName, String storageKey, Integer rank, String context)

Parameters

Type	Name	Description
String	storageType
String	providerName
String	storageKey
Integer	rank
String	context

Returns

Type	Description
NSArchiveRestrictionGroup

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
Integer rank;
String context;
NSArchiveRestrictionGroup res = agent.GetRestrictionGroup(storageType, providerName, storageKey, rank, context);

GetRestrictionGroups(String,String,String,String)

Returns all the restriction groups.

Declaration

NSArchiveRestrictionGroup[] GetRestrictionGroups(String storageType, String providerName, String storageKey, String context)

Parameters

Type	Name	Description
String	storageType
String	providerName
String	storageKey
String	context

Returns

Type	Description
NSArchiveRestrictionGroup[]

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
String context;
NSArchiveRestrictionGroup[] res = agent.GetRestrictionGroups(storageType, providerName, storageKey, context);

GetSpecifiedCriteriaInformationWithDefaults(String,String,String,String[],String[])

Gets criteria information from a set of saved criteria, for a specific set of columns. The result contains the restrictions in two forms: fully populated NSArchiveRestrictionInfo objects, used to display details and for saving changes; and as a list suitable for an Archive control. ALL columns specified in the call will be present in the results; those that do not have corresponding criteria set will have empty values and the default (first) operator, with the IsActive flag set to false.

Declaration

NSCriteriaInformation GetSpecifiedCriteriaInformationWithDefaults(String storageType, String providerName, String storageKey, String[] desiredColumnNames, String[] staticColumns)

Parameters

Type	Name	Description
String	storageType
String	providerName
String	storageKey
String[]	desiredColumnNames
String[]	staticColumns

Returns

Type	Description
NSCriteriaInformation

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
String[] desiredColumnNames;
String[] staticColumns;
NSCriteriaInformation res = agent.GetSpecifiedCriteriaInformationWithDefaults(storageType, providerName, storageKey, desiredColumnNames, staticColumns);

GetSpecifiedCriteriaInformationWithDefaultsWithContext(String,String,String,String[],String[],String)

Declaration

NSCriteriaInformation GetSpecifiedCriteriaInformationWithDefaultsWithContext(String storageType, String providerName, String storageKey, String[] desiredColumnNames, String[] staticColumns, String context)

Parameters

Type	Name	Description
String	storageType
String	providerName
String	storageKey
String[]	desiredColumnNames
String[]	staticColumns
String	context

Returns

Type	Description
NSCriteriaInformation

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
String[] desiredColumnNames;
String[] staticColumns;
String context;
NSCriteriaInformation res = agent.GetSpecifiedCriteriaInformationWithDefaultsWithContext(storageType, providerName, storageKey, desiredColumnNames, staticColumns, context);

PopulateRestrictions(String,NSArchiveRestrictionInfo[])

Takes an incoming set of minimally populated restrictions (name + operator is required), and populates all the other parts of the NSArchiveRestrictionInfo structure. This includes column information, display values (including list value lookup), and calculated/default values where the value hints specify read-only (R).

Declaration

NSArchiveRestrictionInfo[] PopulateRestrictions(String providerName, NSArchiveRestrictionInfo[] restrictions)

Parameters

Type	Name	Description
String	providerName
NSArchiveRestrictionInfo[]	restrictions

Returns

Type	Description
NSArchiveRestrictionInfo[]

Examples

NSFindAgent agent;
String providerName;
NSArchiveRestrictionInfo[] restrictions;
NSArchiveRestrictionInfo[] res = agent.PopulateRestrictions(providerName, restrictions);

PopulateRestrictionValues(NSArchiveRestrictionInfo[])

Takes an incoming set of Restrictions (name + operator + any user-entered values), and populates/expands all values as specified by the operator's ValueHints, taking into account any values already there. Used for dynamic date periods; perhaps others in the future

Declaration

NSArchiveRestrictionInfo[] PopulateRestrictionValues(NSArchiveRestrictionInfo[] restrictions)

Parameters

Type	Name	Description
NSArchiveRestrictionInfo[]	restrictions	Restrictions to populate. The Name and Operator fields have to have valid content, and Values should be set as appropriate. Other fields can be left blank or null and will not be changed.

Returns

Type	Description
NSArchiveRestrictionInfo[]

Examples

NSFindAgent agent;
NSArchiveRestrictionInfo[] restrictions;
NSArchiveRestrictionInfo[] res = agent.PopulateRestrictionValues(restrictions);

SaveRestrictionGroup(String,String,String,NSArchiveRestrictionGroup,String)

Saves an array of restrictions as a restriction group for later use as search criteria (including as dynamic selection and Find).

Declaration

Void SaveRestrictionGroup(String storageType, String providerName, String storageKey, NSArchiveRestrictionGroup restrictionGroup, String context)

Parameters

Type	Name	Description
String	storageType
String	providerName
String	storageKey
NSArchiveRestrictionGroup	restrictionGroup
String	context

Returns

Type	Description
Void

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
NSArchiveRestrictionGroup restrictionGroup;
String context;
agent.SaveRestrictionGroup(storageType, providerName, storageKey, restrictionGroup, context);

SaveRestrictionGroups(String,String,String,NSArchiveRestrictionGroup[],String)

Saves and re-ranks an array of restriction groups, returning the possibly modified array.

Declaration

NSArchiveRestrictionGroup[] SaveRestrictionGroups(String storageType, String providerName, String storageKey, NSArchiveRestrictionGroup[] restrictionGroups, String context)

Parameters

Type	Name	Description
String	storageType
String	providerName
String	storageKey
NSArchiveRestrictionGroup[]	restrictionGroups
String	context

Returns

Type	Description
NSArchiveRestrictionGroup[]

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
NSArchiveRestrictionGroup[] restrictionGroups;
String context;
NSArchiveRestrictionGroup[] res = agent.SaveRestrictionGroups(storageType, providerName, storageKey, restrictionGroups, context);

SaveRestrictions(String,String,NSArchiveRestrictionInfo[],String)

Saves an array of restrictions for later use as search criteria (including as dynamic selection and Find).

Declaration

Void SaveRestrictions(String storageType, String providerName, String storageKey, NSArchiveRestrictionInfo[] restrictions)

Parameters

Type	Name	Description
String	storageType
String	providerName
String	storageKey

Returns

Type	Description
Void

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
NSArchiveRestrictionInfo[] restrictions;
agent.SaveRestrictions(storageType, providerName, storageKey, restrictions);

SaveRestrictions2(String,String,String,String)

Saves an array of restrictions for later use as search criteria (including as dynamic selection and Find).

Declaration

Void SaveRestrictions2(String storageType, String providerName, String storageKey, String restrictions)

Parameters

Type	Name	Description
String	storageType
String	providerName
String	storageKey
String	restrictions

Returns

Type	Description
Void

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
String restrictions;
agent.SaveRestrictions2(storageType, providerName, storageKey, restrictions);

SaveRestrictionsAndGetCriteriaInformation(String,String,String,NSArchiveRestrictionInfo[],String[])

Saves an array of restrictions for later use as search criteria (including as dynamic selection and Find). Then, return the same result as a call to GetCriteriaInformation would have done. The purpose is to encapsulate saving and updating of a GUI in one round trip.

Declaration

NSCriteriaInformation SaveRestrictionsAndGetCriteriaInformation(String storageType, String providerName, String storageKey, NSArchiveRestrictionInfo[] restrictions, String[] staticColumns)

Parameters

Type	Name	Description
String	storageType
String	providerName
String	storageKey
NSArchiveRestrictionInfo[]	restrictions
String[]	staticColumns

Returns

Type	Description
NSCriteriaInformation

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
NSArchiveRestrictionInfo[] restrictions;
String[] staticColumns;
NSCriteriaInformation res = agent.SaveRestrictionsAndGetCriteriaInformation(storageType, providerName, storageKey, restrictions, staticColumns);

SaveRestrictionsAndGetCriteriaInformation2(String,String,String,String,String)

Declaration

NSCriteriaInformation SaveRestrictionsAndGetCriteriaInformation2(String storageType, String providerName, String storageKey, String restrictions, String staticColumns)

Parameters

Type	Name	Description
String	storageType
String	providerName
String	storageKey
String	restrictions
String	staticColumns

Returns

Type	Description
NSCriteriaInformation

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
String restrictions;
String staticColumns;
NSCriteriaInformation res = agent.SaveRestrictionsAndGetCriteriaInformation2(storageType, providerName, storageKey, restrictions, staticColumns);

SaveRestrictionsWithContext(String,String,String,NSArchiveRestrictionInfo[],String)

Saves an array of restrictions for later use as search criteria (including as dynamic selection and Find).

Declaration

Void SaveRestrictionsWithContext(String storageType, String providerName, String storageKey, NSArchiveRestrictionInfo[] restrictions, String context)

Parameters

Type	Name	Description
String	storageType
String	providerName
String	storageKey
NSArchiveRestrictionInfo[]	restrictions
String	context

Returns

Type	Description
Void

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
NSArchiveRestrictionInfo[] restrictions;
String context;
agent.SaveRestrictionsWithContext(storageType, providerName, storageKey, restrictions, context);

SaveRestrictionsWithContext2(String,String,String,String,String)

Saves an array of restrictions for later use as search criteria (including as dynamic selection and Find).

Declaration

Void SaveRestrictionsWithContext2(String storageType, String providerName, String storageKey, String restrictions, String context)

Parameters

Type	Name	Description
String	storageType
String	providerName
String	storageKey
String	restrictions
String	context

Returns

Type	Description
Void

Examples

NSFindAgent agent;
String storageType;
String providerName;
String storageKey;
String restrictions;
String context;
agent.SaveRestrictionsWithContext2(storageType, providerName, storageKey, restrictions, context);