net.rim.device.api.collection.util
Class BasicFilteredListResult

java.lang.Object
  extended by net.rim.device.api.collection.util.BasicFilteredListResult

public class BasicFilteredListResult
extends Object

A basic implementation of FilteredListResult, which only contains the _results object, for storing the matches obtained from BasicFilteredList.

Since:
BlackBerry API 5.0.0

Field Summary
 int _id
          The unique ID of the data set.
 String[] _matchedFieldNames
          The names of the _matchedFields, indicating what they represent.
 String[][] _matchedFieldValues
          The values of the _matchedFields.
 long[] _matchedFields
          The data fields whose string matched the search string.
 String _name
          The name of the data set or data source this matching object belongs to.
 Object _object
          The data object whose string(s) matched the search text.
 long _primaryField
          The primary field, usually for display purposes.
 String[] _requestedFieldNames
          The names of the data fields that were requested for display purposes (or any other purpose).
 String[][] _requestedFieldValues
          The strings of the data fields that were requested for display purposes (or any other purpose).
 long[] _requestedFields
          The data fields that whose strings were requested for display purposes (or any other purpose).
 long[] _searchFields
          The data fields that were searched.
 long _secondaryField
          The secondary field, usually for display purposes.
 int _type
          The type of data.
 
Constructor Summary
BasicFilteredListResult()
          Constructor for the BasicFilteredListResult.
 
Method Summary
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Field Detail

_id

public int _id
The unique ID of the data set.

Since:
BlackBerry API 5.0.0

_name

public String _name
The name of the data set or data source this matching object belongs to.

Since:
BlackBerry API 5.0.0

_object

public Object _object
The data object whose string(s) matched the search text.

Since:
BlackBerry API 5.0.0

_type

public int _type
The type of data. It can be one of: -1 (generic data added with addData() method) DATA_SOURCE_CONTACTS DATA_SOURCE_MEMOS DATA_SOURCE_MUSIC DATA_SOURCE_PICTURES DATA_SOURCE_RINGTONES DATA_SOURCE_TASKS DATA_SOURCE_VIDEOS DATA_SOURCE_VOICENOTES

Since:
BlackBerry API 5.0.0

_searchFields

public long[] _searchFields
The data fields that were searched. This is null if not from a data source (i.e. if from an array of strings or objects).

Since:
BlackBerry API 5.0.0

_matchedFields

public long[] _matchedFields
The data fields whose string matched the search string. This is null if not from a data source (i.e. if from an array of strings or objects).

Since:
BlackBerry API 5.0.0

_matchedFieldNames

public String[] _matchedFieldNames
The names of the _matchedFields, indicating what they represent. This is null if not from a data source (i.e. from an array of strings or objects).

Since:
BlackBerry API 5.0.0

_matchedFieldValues

public String[][] _matchedFieldValues
The values of the _matchedFields. This is null if not from a data source (i.e. from an array of strings or objects).

Since:
BlackBerry API 5.0.0

_requestedFields

public long[] _requestedFields
The data fields that whose strings were requested for display purposes (or any other purpose). This is null if not from a data source (i.e. if from an array of strings or objects).

Since:
BlackBerry API 5.0.0

_requestedFieldNames

public String[] _requestedFieldNames
The names of the data fields that were requested for display purposes (or any other purpose). These indicate what the requestedFields represent. These are in the same order as the _requestedFields array. This is null if not from a data source (i.e. from an array of strings or objects).

Since:
BlackBerry API 5.0.0

_requestedFieldValues

public String[][] _requestedFieldValues
The strings of the data fields that were requested for display purposes (or any other purpose). These are in the same order as the _requestedFields array. It is multidimensional because some fields can have more than one value, such as BasicFilteredList.DATA_FIELD_CONTACTS_EMAIL. This is null if not from a data source (i.e. from an array of strings or objects).

Since:
BlackBerry API 5.0.0

_primaryField

public long _primaryField
The primary field, usually for display purposes. This is -1 if not from a data source (i.e. if from an array of strings or objects).

Since:
BlackBerry API 5.0.0

_secondaryField

public long _secondaryField
The secondary field, usually for display purposes. This is -1 if not from a data source (i.e. if from an array of strings or objects).

Since:
BlackBerry API 5.0.0


Constructor Detail

BasicFilteredListResult

public BasicFilteredListResult()
Constructor for the BasicFilteredListResult.

Since:
BlackBerry API 5.0.0





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.