net.rim.device.api.unifiedsearch
Class SearchField

java.lang.Object
  extended by net.rim.device.api.unifiedsearch.SearchField

public class SearchField
extends Object

Metadata about the searchable content an application inserts into the Unified Search Framework. An application must provide one SearchField for each searchable property of the data that it inserts into the Framework.

In addition to the structured information provided by SearchField, a developer can associate additional data by using setTag. An application that consumes the content provided by this SearchField can use getTag to retrieve the additional information.

Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

Constructor Summary
Category: Signed SearchField(String name)
          Initializes a new SearchField.
Category: Signed SearchField(String name, boolean isPublic)
          Initializes a new SearchField.
Category: Signed SearchField(String name, String description)
          Initializes a new SearchField.
Category: Signed SearchField(String name, String description, boolean isPublic)
          Initializes a new SearchField.
 
Method Summary
Category: Signed  String getDescription()
          Returns the description of this SearchField.
Category: Signed  String getName()
          Returns the name of this SearchField.
Category: Signed  Object getTag()
          Returns the object's tag.
Category: Signed  boolean isPublic()
          Indicates whether this SearchField is included in all searches, or only when explicitly referenced.
Category: Signed  void setDescription(String description)
          Sets the description of this SearchField.
Category: Signed  void setTag(Object tag)
          Sets the object's tag field.
Category: Signed  String toString()
          Returns the name of this SearchField.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 



Constructor Detail

SearchField

public SearchField(String name)
Initializes a new SearchField.

Parameters:
name - The field's name.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

SearchField

public SearchField(String name,
                   boolean isPublic)
Initializes a new SearchField.

Parameters:
name - The field's name.
isPublic - true if the field is included in Search All queries; false if field must be explicitly referenced to be included in searches.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

SearchField

public SearchField(String name,
                   String description)
Initializes a new SearchField.

Parameters:
name - The field's name.
description - The field's description.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

SearchField

public SearchField(String name,
                   String description,
                   boolean isPublic)
Initializes a new SearchField.

Parameters:
name - The field's name.
description - The field's description.
isPublic - true if the field is included in Search All queries; false if field must be explicitly referenced to be included in searches.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0


Method Detail

isPublic

public boolean isPublic()
Indicates whether this SearchField is included in all searches, or only when explicitly referenced.

Returns:
true if the field is included in Search All queries; false if field must be explicitly referenced to be included in searches.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

getDescription

public String getDescription()
Returns the description of this SearchField.

Returns:
The description of this SearchField.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

setDescription

public void setDescription(String description)
Sets the description of this SearchField.

Parameters:
description - The description to set.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

getTag

public Object getTag()
Returns the object's tag. A tag allows a developer to associate additional data with a SearchField.

Returns:
An Object.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

setTag

public void setTag(Object tag)
Sets the object's tag field. The tag allows a developer to associate additional data with a SearchField.

Parameters:
tag - Any Object reference.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

getName

public String getName()
Returns the name of this SearchField.

Returns:
The name of this SearchField.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

toString

public String toString()
Returns the name of this SearchField.

Overrides:
toString in class Object
Returns:
The name of this SearchField.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.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.