SHOW Signed

net.rim.blackberry.api.phone.phonelogs
Class PhoneCallLogID

java.lang.Object
  |
  +--net.rim.blackberry.api.phone.phonelogs.PhoneCallLogID

public final class PhoneCallLogID

extends Object

Represents the caller ID information associated with a phone call log.

This is the information that shows up as the caller in the message list and when a log gets opened for viewing.

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 4.0.0

Constructor Summary

PhoneCallLogID(String number) Creates a new PhoneCallLogID instance.

Method Summary

	String	getAddressBookFormattedNumber() Retrieves the formatted (address book) phone number for this caller ID.
	String	getName() Retrieves the name associated with this caller ID.
	String	getNumber() Retrieves the original number for this caller ID.
	void	setName(String name) Sets the name for this caller ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

PhoneCallLogID

public PhoneCallLogID(String number)

Creates a new PhoneCallLogID instance.

The phone number given acts like the identifier for the object. If the number exists in the address book, then all the caller information in the address book gets transferred to this object (name, company, etc.). If not, then a blank object is created with the number as the main identification.

Parameters:

number - Phone number for this caller.

Since:

JDE 4.0.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.

Method Detail

getName

public String getName()

Retrieves the name associated with this caller ID.

If the number specified on creation has no associated address book entry, this method null.

Returns:

The caller ID name, or null.

Since:

JDE 4.0.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.

getNumber

public String getNumber()

Retrieves the original number for this caller ID.

Use this method to retrieve the original phone number given to this object when it was created. Note that this number may be different in format to the number in an associated address book entry for a known caller.

Returns:

Original phone number provided to this object's constructor.

Since:

JDE 4.0.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.

getAddressBookFormattedNumber

public String getAddressBookFormattedNumber()

Retrieves the formatted (address book) phone number for this caller ID.

Returns:

If the identified caller is known (exists in the address book), this method returns the formatted number in the entry if there is one; otherwise, this method returns an empty string.

Since:

JDE 4.0.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.

setName

public void setName(String name)

Sets the name for this caller ID. This menu overrides the name as it appears in the address book (if the number had an associated name in the first place).

Parameters:

name - New name for this caller ID.

Since:

JDE 4.0.2

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.