Class NSFindAgent

NSFindAgent()

Find functions.

Declaration

NSFindAgent

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

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)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

GetCriteriaInformationWithContext(String,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 GetCriteriaInformationWithContext(String storageType, String providerName, String storageKey, String[] staticColumns, String context)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

GetDefaultDesiredColumnsFromRestrictions2(String,String)

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[] GetDefaultDesiredColumnsFromRestrictions2(String providerName, String restrictions)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

GetRestrictionGroups(String,String,String,String)

Returns all the restriction groups.

Declaration

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

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

Parameters

Returns

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)

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

Parameters

Returns

GetSpecifiedCriteriaInformationWithDefaultsWithContext(String,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 GetSpecifiedCriteriaInformationWithDefaultsWithContext(String storageType, String providerName, String storageKey, String[] desiredColumnNames, String[] staticColumns, String context)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns

SaveRestrictionsAndGetCriteriaInformation2(String,String,String,String,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 SaveRestrictionsAndGetCriteriaInformation2(String storageType, String providerName, String storageKey, String restrictions, String staticColumns)

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

Parameters

Returns

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)

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

Parameters

Returns

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)

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

Parameters

Returns