Find functions.
Constructors
NSFindAgent()
Find functions.
Methods
CreateRestrictionGroup(String,String,String,String)
Creates a restriction group, initialized with next rank etc.
Returns: CRMScript.NetServer.NSArchiveRestrictionGroup
Example:
DeleteRestrictionGroup(String,String,String,Integer,String)
Creates a restriction group, initialized with next rank etc.
Returns: CRMScript.Global.Void
Example:
Find(String,String,String,Integer,Integer)
Executes a Find operation and return a page of results.
Returns: CRMScript.NetServer.NSFindResults
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 columns are also calculated by the system.The other variants of the Find method allow you greater control over the individual aspects of the process.
Example:
FindFromRestrictions(NSArchiveRestrictionInfo[],String,Integer,Integer)
Executes a Find operation and return a page of results.
Returns: CRMScript.NetServer.NSFindResults
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.
Example:
FindFromRestrictions2(String,String,Integer,Integer)
Executes a Find operation and return a page of results.
Returns: CRMScript.NetServer.NSFindResults
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.
Example:
FindFromRestrictionsColumns(NSArchiveRestrictionInfo[],String,String[],Integer,Integer)
Executes a Find operation and return a page of results.
Returns: CRMScript.NetServer.NSFindResults
The criteria for the Find are passed in directly, not fetched by a restriction storage provider.<para/>The desired columns of the result set are also passed in directly.<para/>The orderby information is calculated by the system.<para/>Use the GetCriteriaInformation and GetDefaultDesiredColumns service methods to let the system calculate these values, if you want to use or modify them.n
Example:
FindFromRestrictionsColumns2(String,String,String,Integer,Integer)
Execute a Find operation and return a page of results.
Returns: CRMScript.NetServer.NSFindResults
The criteria for the Find are passed in directly, not fetched by a restriction storage provider.<para/>The desired columns of the result set are also passed in directly.<para/>The orderby information is calculated by the system.<para/>Use the GetCriteriaInformation and GetDefaultDesiredColumns service methods to let the system calculate these values, if you want to use or modify them.
Example:
FindFromRestrictionsColumnsOrderBy(String,String[],Integer,Integer)
Executes a Find operation and return a page of results.
Returns: CRMScript.NetServer.NSFindResults
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.<para/>Use the GetCriteriaInformation, GetDefaultDesiredColumns and GetDefaultOrderBy service methods to let the system calculate these values, if you want to use or modify them.
Example:
FindFromRestrictionsColumnsOrderBy2(String,String,String,String,Integer,Integer)
Executes a Find operation and return a page of results.
Returns: CRMScript.NetServer.NSFindResults
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.<para/>Use the GetCriteriaInformation, GetDefaultDesiredColumns and GetDefaultOrderBy service methods to let the system calculate these values, if you want to use or modify them.
Example:
FindOrderBy(String,String,String,Integer,Integer)
Executes a Find operation and return a page of results.
Returns: CRMScript.NetServer.NSFindResults
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.<para/>The other variants of the Find method allow you greater control over the individual aspects of the process.
Example:
FindOrderBy2(String,String,String,Integer,Integer,String)
Executes a Find operation and return a page of results.
Returns: CRMScript.NetServer.NSFindResults
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.<para/>The other variants of the Find method allow you greater control over the individual aspects of the process.
Example:
FindWithColumns(String,String,String,String[],Integer,Integer)
Executes a Find operation and return a page of results.
Returns: CRMScript.NetServer.NSFindResults
The criteria for the Find are fetched from the restriction storage provider according to the given parameters.
Example:
Execute a Find operation and return a page of results.
Returns: CRMScript.NetServer.NSFindResults
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.
Example:
Executes a Find operation and return a page of results.
Returns: CRMScript.NetServer.NSFindResults
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.
Example:
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.
Returns: CRMScript.Global.String[] - list of the column names corresponding to available restrictions for a certain archive provider.
Example:
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
Returns: CRMScript.NetServer.NSCriteriaInformation
Example:
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
Returns: CRMScript.NetServer.NSCriteriaInformation
Example:
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.
Returns: CRMScript.NetServer.NSArchiveColumnInfo[]
Example:
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.
Returns: CRMScript.NetServer.NSArchiveColumnInfo[]
Example:
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.
Returns: CRMScript.NetServer.NSArchiveColumnInfo[]
Example:
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.
Returns: CRMScript.NetServer.NSArchiveOrderByInfo[]
Example:
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.
Returns: CRMScript.NetServer.NSArchiveOrderByInfo[]
Example:
GetRestrictionGroup(String,String,String,Integer,String)
Return the restriction group with given rank or a blank carrier.
Returns: CRMScript.NetServer.NSArchiveRestrictionGroup
Example:
GetRestrictionGroups(String,String,String,String)
Returns all the restriction groups.
Returns: CRMScript.NetServer.NSArchiveRestrictionGroup[]
Example:
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.
Returns: CRMScript.NetServer.NSCriteriaInformation
Example:
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.
Returns: CRMScript.NetServer.NSCriteriaInformation
Example:
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).
Returns: CRMScript.NetServer.NSArchiveRestrictionInfo[]
Example:
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
Returns: CRMScript.NetServer.NSArchiveRestrictionInfo[]
Example:
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).
Returns: CRMScript.Global.Void
Example:
SaveRestrictionGroups(String,String,String,NSArchiveRestrictionGroup[],String)
Saves and re-ranks an array of restriction groups, returning the possibly modified array.
Returns: CRMScript.NetServer.NSArchiveRestrictionGroup[]
Example:
SaveRestrictions(String,String,NSArchiveRestrictionInfo[],String)
Saves an array of restrictions for later use as search criteria (including as dynamic selection and Find).
Returns: CRMScript.Global.Void
Example:
SaveRestrictions2(String,String,String,String)
Saves an array of restrictions for later use as search criteria (including as dynamic selection and Find).
Returns: CRMScript.Global.Void
Example:
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.
Returns: CRMScript.NetServer.NSCriteriaInformation
Example:
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.
Returns: CRMScript.NetServer.NSCriteriaInformation
Example:
SaveRestrictionsWithContext(String,String,String,NSArchiveRestrictionInfo[],String)
Saves an array of restrictions for later use as search criteria (including as dynamic selection and Find).
Returns: CRMScript.Global.Void
Example:
SaveRestrictionsWithContext2(String,String,String,String,String)
Saves an array of restrictions for later use as search criteria (including as dynamic selection and Find).
Returns: CRMScript.Global.Void
Example: