net.rim.blackberry.api.messagelist
Class ApplicationMessageSearchProperties

java.lang.Object
  net.rim.blackberry.api.messagelist.ApplicationMessageSearchProperties

public class ApplicationMessageSearchProperties
extends Object

Defines message search properties. Application may define which message attributes participate in the message filtering. By default all the message attributes participate in the search operation. Refer to the ApplicationMessageFolder.setSearchProperties(ApplicationMessageSearchProperties) method.

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 4.6.0

Constructor Summary
	ApplicationMessageSearchProperties(boolean searchSupported) Creates search properties with specified operation support value.

Method Summary
	boolean	isSearchByNameSupported() Returns if search by contact name is supported
	boolean	isSearchByPreviewTextSupported() Returns if search by message preview text is supported
	boolean	isSearchByStatusSupported() Returns if search by message status is supported
	boolean	isSearchBySubjectSupported() Returns if search by message subject is supported
	boolean	isSearchSupported() Returns if message search is supported
	void	setSearchByNameSupported(boolean supportsSearchByName) Sets if search by contact name should be supported
	void	setSearchByPreviewTextSupported(boolean supportsSearchByPreviewText) Sets if search by message preview text should be supported
	void	setSearchByStatusSupported(boolean supportsSearchByStatus) Sets if search by message status should be supported
	void	setSearchBySubjectSupported(boolean supportsSearchBySubject) Sets if search by message subject should be supported
	void	setSearchSupported(boolean searchSupported) Sets if search should be supported

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApplicationMessageSearchProperties

public ApplicationMessageSearchProperties(boolean searchSupported)

Creates search properties with specified operation support value. If the given parameter value is true then all message attributes will participate in the message search.

Parameters:

searchSupported - defines if message search is supported

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 4.6.0

Method Detail

isSearchSupported

public boolean isSearchSupported()

Returns if message search is supported

Returns:

true if supported false otherwise

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 4.6.0

setSearchSupported

public void setSearchSupported(boolean searchSupported)

Sets if search should be supported

Parameters:

searchSupported - true if supported false otherwise

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 4.6.0

isSearchByNameSupported

public boolean isSearchByNameSupported()

Returns if search by contact name is supported

Returns:

true if supported false otherwise

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 4.6.0

setSearchByNameSupported

public void setSearchByNameSupported(boolean supportsSearchByName)

Sets if search by contact name should be supported

Parameters:

supportsSearchByName -

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 4.6.0

isSearchBySubjectSupported

public boolean isSearchBySubjectSupported()

Returns if search by message subject is supported

Returns:

true if supported false otherwise

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 4.6.0

setSearchBySubjectSupported

public void setSearchBySubjectSupported(boolean supportsSearchBySubject)

Sets if search by message subject should be supported

Parameters:

supportsSearchBySubject -

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 4.6.0

isSearchByPreviewTextSupported

public boolean isSearchByPreviewTextSupported()

Returns if search by message preview text is supported

Returns:

true if supported false otherwise

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 4.6.0

setSearchByPreviewTextSupported

public void setSearchByPreviewTextSupported(boolean supportsSearchByPreviewText)

Sets if search by message preview text should be supported

Parameters:

supportsSearchByPreviewText -

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 4.6.0

isSearchByStatusSupported

public boolean isSearchByStatusSupported()

Returns if search by message status is supported

Returns:

true if supported false otherwise

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 4.6.0

setSearchByStatusSupported

public void setSearchByStatusSupported(boolean supportsSearchByStatus)

Sets if search by message status should be supported

Parameters:

supportsSearchByStatus -

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 4.6.0