The ATL COM module miscValidator provides methods to
browse, search & validate records of varied tariffs
browse, search & validate records of varied tariffs
API browser of miscValidator200 COM module
ISearch interface | V2.00/ 1 May 2014 | ||
---|---|---|---|
The ISearch interface allows browsing and retrieval of detailed service information from the selected tariff catalog. A search process in the service record domain of the selected tariff catalog can be performed by code, name, or chapter respectively. The search terms may be specified in full or may include wildcards. After a successful search, all of the available information directly related to the search term is made available through the interface"s properties.
The search methods (e.g. SearchName) produce as a result a selection list, composed of zero or more service records. The total number of records in the list can be retrieved with the GetRecordCount method. The record pointer is initially positioned at the first entry of the selection list and the positioning methods MoveFirst, MoveLast, MoveNext, MovePrevious, PutAbsolutePosition, and GetAbsolutePosition are used to manipulate the selected record. The information related to the current record is made available through the interface"s properties like GetName for retrieving the service title. |
|||
Methods | 13 methods | ||
GetAbortInfo | Fetches the abort/error information if there is any stored | ||
GetAbsolutePosition | Gets the current absolute position of the record pointer in the selection list | ||
GetPropertyValue | Gets the explicit value of predefined property always returned in string form | ||
GetRecordCount | Gets the number of service records in the selection list based on the last search call | ||
GetServices | Method for collecting all service records of the resulting search space in one call without the necessity to call the record positioning methods and the appropriate properties of this interface | ||
MoveFirst | Moves the record pointer to the first record in the selection list and makes that record the current record | ||
MoveLast | Moves the record pointer to the last record in the selection list and makes that record the current record | ||
MoveNext | Moves the record pointer to the next record in the selection list and makes that record the current record | ||
MovePrevious | Moves the record pointer to the previous record in the selection list and makes that record the current record | ||
PutAbsolutePosition | Positions the record pointer at the specified absolute position in the selection list. | ||
SearchChapter | This method searches for services included in the given chapter query expression | ||
SearchCode | This method searches for services by code | ||
SearchName | This method searches for services by name | ||
Properties | 10 properties | ||
[get] ChapterCode | The chapter code the given service record belongs to | ||
[get] Code | The code of the selected service record | ||
[put] DestructSearch | Destructs/invalidates this ISearch interface instance | ||
[get] Interpretation | The interpretation (exclusion and inclusion remarks, rules, comments and the like) of the selected service | ||
[get] Name | The name of the selected service record | ||
[get] ReferenceCode | Returns a comma-separated list of reference codes where the selected service is obliged to map to one of the given services | ||
[get] ServiceProperties | This value defines all semantic capabilities of a service | ||
[get] TariffType | The tariff type the selected service record belongs to | ||
[get] ValidFrom | The validity start date of the selected service record | ||
[get] ValidTo | The validity end date of the selected service record | ||