SHOW Signed

net.rim.blackberry.api.pim
Interface BlackBerryPIMList

All Superinterfaces:

PIMList

public interface BlackBerryPIMList

extends PIMList

Contains the functionality for the BlackBerry-specific implementation of the PIMList.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:

JDE 3.6.0

Fields inherited from interface net.rim.blackberry.api.pim.PIMList

UNCATEGORIZED

Method Summary

	void	addListener(PIMListListener listener) Adds a PIMListListener to this PIMList.
	boolean	isFieldLabelSettable(int field) Returns a boolean indicating whether or not a field label can be set.
	void	removeListener(PIMListListener listener) Removes a PIMListListener from this PIMList.
	void	setFieldLabel(int field, String value) Sets a label for a given field.

Methods inherited from interface net.rim.blackberry.api.pim.PIMList

addCategory, close, deleteCategory, getArrayElementLabel, getAttributeLabel, getCategories, getFieldDataType, getFieldLabel, getName, getSupportedArrayElements, getSupportedAttributes, getSupportedFields, isCategory, isSupportedArrayElement, isSupportedAttribute, isSupportedField, items, items, items, itemsByCategory, maxCategories, maxValues, renameCategory

Method Detail

addListener

public void addListener(PIMListListener listener)

Adds a PIMListListener to this PIMList.

Note that the listener will remain associated with the native device database even after the correspoding PIMList object has been deleted. To remove the listener use the removeListener method.

Parameters:

listener - The PIMListListener to add.

Since:

JDE 3.7.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

removeListener

public void removeListener(PIMListListener listener)

Removes a PIMListListener from this PIMList.

Parameters:

listener - The PIMListListener to remove.

Since:

JDE 3.7.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

setFieldLabel

public void setFieldLabel(int field,
                          String value)

Sets a label for a given field.

This method silently fails if the field is invalid, or the field label for the specified field is not settable. Use the isFieldLableSettable method to determine if the field label is settable for this field.

Currently only the BlackBerryContact.USER1 - BlackBerryContact.USER4 fields have settable labels.

Parameters:

field - The field for which to set a label.

value - A string value representing the new label for the field.

Since:

JDE 3.7.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

isFieldLabelSettable

public boolean isFieldLabelSettable(int field)

Returns a boolean indicating whether or not a field label can be set.

Parameters:

field - The field to check.

Returns:

A boolean indicating whether or not the field can be set.

Since:

JDE 3.7.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.