SHOW Signed

net.rim.blackberry.api.mail
Class ServiceConfiguration

java.lang.Object
  |
  +--net.rim.blackberry.api.mail.ServiceConfiguration

public class ServiceConfiguration

extends Object

Encapsulates information used to describe a particular mail service.

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.

Field Summary

static String

NO_SERVICE_BOOK This constant describes the string used to identify the root folder name for folders belonging to a hierarchy without a corresponding service book entry

Constructor Summary

	ServiceConfiguration() Default constructor, with no parameters.
	ServiceConfiguration(String uid, String cid) Creates a new ServiceConfiguration instance.

Method Summary

	boolean	equals(Object o) Determines if two ServiceConfiguration instances are identical.
	String	getCID() Retrieves the CID of this service.
	String	getEmailAddress() Retrieves the email address associated with this service.
	String	getName() Retrieves the name of the internal service that this ServiceConfiguration encapsulates.
	String	getUID() Retrieves the UID of this service.
	int	hashCode() Returns a hash code value for the object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_SERVICE_BOOK

public static String NO_SERVICE_BOOK

This constant describes the string used to identify the root folder name for folders belonging to a hierarchy without a corresponding service book entry

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.

Constructor Detail

ServiceConfiguration

public ServiceConfiguration()

Default constructor, with no parameters.

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.

ServiceConfiguration

public ServiceConfiguration(String uid,
                            String cid)
                     throws NoSuchServiceException

Creates a new ServiceConfiguration instance.

Parameters:

uid - Unique ID (UID) of the service, as described in the Options > Service Book screen.

cid - Content ID (CID) of the service, as described in the Options > Service Book screen.

Throws:

NoSuchServiceException - if no matching service exists

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

getUID

public String getUID()

Retrieves the UID of this service.

Returns:

Service Unique ID (UID) as a String.

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.

getCID

public String getCID()

Retrieves the CID of this service.

Returns:

Service Content ID (CID) as a String.

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.

equals

public boolean equals(Object o)

Determines if two ServiceConfiguration instances are identical.

Overrides:

equals in class Object

Parameters:

sc - The ServiceConfiguration object to compare to this service configuration.

Returns:

True if the ServiceConfiguration instances are the same; otherwise false.

Since:

JDE 3.6

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.

hashCode

public int hashCode()

Description copied from class: Object

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Overrides:

hashCode in class Object

Following copied from class: java.lang.Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), Hashtable

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.

getName

public String getName()

Retrieves the name of the internal service that this ServiceConfiguration encapsulates.

Returns:

The name of then internal service, as described in the Options > Service Book screen.

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.

getEmailAddress

public String getEmailAddress()

Retrieves the email address associated with this service.

Returns:

The email address associated with this service

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.