![]() | AFNotificationRuleSearch Class |
Namespace: OSIsoft.AF.Search
The AFNotificationRuleSearch type exposes the following members.
Name | Description | |
---|---|---|
![]() | AFNotificationRuleSearch(AFDatabase, String, IListAFSearchToken) | Obsolete.
Creates an instance of an AFNotificationRuleSearch to search
for AFNotificationRule objects using the specified list of
search tokens.
|
![]() | AFNotificationRuleSearch(AFDatabase, String, IListAFSearchTokenBase) |
Creates an instance of an AFNotificationRuleSearch to search
for AFNotificationRule objects using the specified list of
search tokens.
|
![]() | AFNotificationRuleSearch(AFDatabase, String, String) |
Creates an instance of an AFNotificationRuleSearch to search
for AFNotificationRule objects using the specified search query
string.
|
Name | Description | |
---|---|---|
![]() | CacheInterval |
The search's cached automatic refresh interval.
(Inherited from AFSearch.) |
![]() | CacheTimeout |
The timeout to clean up the cached search in the server if it has not been used.
(Inherited from AFSearch.) |
![]() | Database |
The AFDatabase to be searched by the query.
(Inherited from AFSearch.) |
![]() | Identity |
This read-only property specifies the identity of the objects returned
from the search.
(Inherited from AFSearch.) |
![]() | PISystem |
The PISystem to be searched by the query.
(Inherited from AFSearch.) |
![]() | SearchName |
The name of the search object.
(Inherited from AFSearch.) |
![]() | ThrowOnError |
Specifies it an exception will be thrown for missing objects or invalid data in the query.
(Inherited from AFSearch.) |
![]() | TokenCollection |
The tokens that represent this search object.
(Inherited from AFSearch.) |
![]() | Tokens | Obsolete.
The tokens that represent this search object.
(Inherited from AFSearch.) |
Name | Description | |
---|---|---|
![]() ![]() | Aggregate |
Performs all requested aggregates on the objects that match the search criteria.
(Inherited from AFSearch.) |
![]() ![]() | AggregateAsync |
Performs all requested aggregates on the objects that match the search criteria asynchronously.
(Inherited from AFSearch.) |
![]() ![]() | BinnedSummaryTBin |
Generates a summary broken down by the specified bins for items matching the search criteria.
(Inherited from AFSearch.) |
![]() ![]() | BinnedSummaryAsyncTBin |
Generates a summary broken down by the specified bins for items matching the search criteria asynchronously.
(Inherited from AFSearch.) |
![]() | Close |
Closes the search that is cached in the server.
(Inherited from AFSearch.) |
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | FindNotificationRules | Obsolete.
This method will return the AFNotificationRule objects that match the
search tokens.
|
![]() ![]() | FindObjectFields(String, Int32, Int32) |
This method will return the values as an IList for the specified fields for each of the objects
that match the search tokens.
(Inherited from AFSearchT.) |
![]() ![]() | FindObjectFieldsTObject(Int32, Int32) |
This method will return the values for the fields defined by the user-defined type for each of the objects
that match the search tokens.
(Inherited from AFSearchT.) |
![]() ![]() | FindObjectFieldsTObject(String, FuncIListObject, TObject, Int32, Int32) |
This method will return the values as an object for the specified fields for each of the objects
that match the search tokens using the supplied factory delegate.
(Inherited from AFSearch.) |
![]() ![]() | FindObjectFieldsTObject(String, FuncIListObject, TObject, Int32, Int32) |
This method will return the values as an object for the specified fields for each of the objects
that match the search tokens using the supplied factory delegate.
(Inherited from AFSearchT.) |
![]() ![]() | FindObjectIds |
This method will return a list of the ID for each object that matches the
search tokens.
(Inherited from AFSearchT.) |
![]() ![]() | FindObjects |
This method will return the objects that match the
search tokens.
(Inherited from AFSearchT.) |
![]() ![]() | FrequencyDistribution |
Generates a frequency distribution for the specified items.
(Inherited from AFSearch.) |
![]() ![]() | FrequencyDistributionAsync |
Generates a frequency distribution for the specified items asynchronously.
(Inherited from AFSearch.) |
![]() ![]() | GetFilters |
Get the full list of valid filters for a search query
for all servers.
|
![]() ![]() | GetFilters(PISystem) |
Get the list of valid filters for a search query
for the specified server.
|
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() ![]() | GetObjectFields |
Get the list of valid object fields that can used for the FindObjectFields(String, Int32, Int32)
search for the specified server.
|
![]() | GetTotalCount |
Returns the total count of the items that could be returned from the search query.
(Inherited from AFSearchT.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() ![]() | GroupedSummary |
Generates summaries broken down by group for items matching the search criteria.
(Inherited from AFSearch.) |
![]() ![]() | GroupedSummaryAsync |
Generates summaries broken down by group for items matching the search criteria asynchronously.
(Inherited from AFSearch.) |
![]() ![]() | HistogramTBin |
Generates a histogram using the specified weighting for items matching this search.
(Inherited from AFSearch.) |
![]() ![]() | HistogramAsyncTBin |
Generates a histogram using the specified weighting for items matching this search asynchronously.
(Inherited from AFSearch.) |
![]() ![]() | IsMatch |
Determines if the specified item matches the search query.
(Inherited from AFSearchT.) |
![]() | Refresh |
Refreshes the search that is cached in the server.
(Inherited from AFSearch.) |
![]() ![]() | Summary(String, AFSummaryTypes) |
Summarizes the result of this search.
(Inherited from AFSearch.) |
![]() | Summary(String, AFSummaryTypes, String) |
Summarizes the result of this search with the specified weighting.
(Inherited from AFSearch.) |
![]() ![]() | SummaryAsync(String, AFSummaryTypes, CancellationToken) |
Summarizes the result of this search asynchronously.
(Inherited from AFSearch.) |
![]() | SummaryAsync(String, AFSummaryTypes, String, CancellationToken) |
Summarizes the result of this search with the specified weighting asynchronously.
(Inherited from AFSearch.) |
![]() | ToString |
Returns a String that represents the current object.
(Inherited from AFSearch.) |
![]() | TryFindSearchToken | Obsolete.
Find the AFSearchToken associated with the specified AFSearchFilter.
(Inherited from AFSearch.) |
![]() | TryFindSearchTokens | Obsolete.
Find the AFSearchToken list associated with the specified AFSearchFilter.
(Inherited from AFSearch.) |
This class provides support for query based searches for AFNotificationRule objects. The QuerySearch feature can be checked to determine if this query search is supported.
A query string is parsed into search tokens which are used to specify the query filters for the search.
To optimize getting items from several pages of search results, a search can be cached by setting the CacheTimeout to a non-zero value. If you will only be getting items from the first page, then it is best to leave the cache disabled. The cache is disabled by default. Call the Refresh method to refresh the results of a cached search. Use the Close method to close a cached search when finished using it to free the memory used by the cached results in the server. Since the search implements the IDisposable interface, you can call the cached search in a using statement to automatically call the Close method when it leaves scope.
![]() |
---|
When a query is too complex for a server, then you will get a NotSupportedException. |
1// Get the Database 2PISystems myPISystems = new PISystems(); 3PISystem myPISystem = myPISystems.DefaultPISystem; 4if (myPISystem == null) 5 throw new InvalidOperationException("Default PISystem was not found."); 6AFDatabase myDB = myPISystem.Databases[dbName]; 7if (myDB == null) 8 throw new InvalidOperationException("Database was not found."); 9 10// Create notification rule search to find all notification rules that have 11// a template name starting with 'Notif'. 12int count; 13using (var search = new AFNotificationRuleSearch(myDB, "MyNotificationRuleSearch", "TemplateName:'Notif*'")) 14{ 15 search.CacheTimeout = TimeSpan.FromMinutes(10); 16 17 // When the notification rules are returned from a find operation, they 18 // are only partially loaded into memory, typically enough to display their 19 // inherent properties, such as Name, Description, Template, etc. 20 // When a piece of information is accessed in the notification rule that requires 21 // more information, an RPC to the server is made to fully load the notification rule. 22 // By having the search do a full load, all information is loaded in bulk and 23 // we can reduce the number of RPCs made to retrieve this information. 24 count = search.GetTotalCount(); 25 Console.WriteLine("Found {0} Notification Rules", count); 26 foreach (var item in search.FindObjects(fullLoad: true)) 27 { 28 Console.Write("Notification Rule Name = {0},", item.Name); 29 Console.Write("Notification Rule Description = {0},", item.Description); 30 Console.Write("Notification Rule Target = {0}", item.Target); 31 Console.WriteLine(); 32 } 33}