FindByIDSpecification Class

  • Article

FindByIDSpecification Class

Contains the search specification used in the FindServiceSoap.FindByID method. Specifies the entity IDs, the search options to use, and the data source from which to get results.


Public Class FindByIDSpecification Inherits System.Object


[C#]

public class FindByIDSpecification : System.Object

Public Properties

Name Description
public propertyDataSourceName

A string representing the name of the data source (DataSource.Name property) in which to search for entities.
public propertyEntityIDs

Array of unique entity IDs. Only points of interest with matching entity IDs are returned by the FindServiceSoap.FindByID method and the rest are ignored.
public propertyFilter

The filter (FindFilter object) to apply to the results; that is, the specific entity type, properties, and values that the returned results must match. Required.
public propertyOptions

The search options (FindOptions object), which may include the range of results and a flag to identify which objects are desired in the returned results.

Example

[Visual Basic]

    Dim findServiceSoap As FindServiceSoap = New FindServiceSoap
    findServiceSoap.Credentials = _
        New NetworkCredential(myMapPointUserId, mySecurePassword)

    Dim findByIDSpecification As FindByIDSpecification = New FindByIDSpecification
    findByIDSpecification.DataSourceName = "MapPoint.FourthCoffeeSample"
    findByIDSpecification.Filter = New FindFilter
    findByIDSpecification.Filter.EntityTypeName = "FourthCoffeeShops"
    Dim nums1 As Integer() = New Integer() {-21835, -21836}
    findByIDSpecification.EntityIDs = nums1

    Dim findResults As FindResults = findServiceSoap.FindByID(findByIDSpecification)



[C#]

   FindServiceSoap findService = new FindServiceSoap();
   findService.Credentials = 
    new System.Net.NetworkCredential(myMapPointUserId, mySecurePassword);

 
   FindByIDSpecification findbyidspec = new FindByIDSpecification();

   findbyidspec.DataSourceName = "MapPoint.FourthCoffeeSample";
   findbyidspec.Filter = new FindFilter();
   findbyidspec.Filter.EntityTypeName = "FourthCoffeeShops";
   int[] arrayID = {-21835, -21836};
   findbyidspec.EntityIDs = arrayID;

   FindResults foundResults;
   foundResults = findService.FindByID(findbyidspec);

See Also

  FindByID Method