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.

Since:

JDE 3.6.0

Field Summary

static String

NO_SERVICE_BOOK Names the root folder for folders belonging to a hierarchy without a corresponding service book entry.

Constructor Summary

	ServiceConfiguration() Creates a new ServiceConfiguration instance.
	ServiceConfiguration(ServiceRecord sr) Creates a new ServiceConfiguration instance with provided service record.
	ServiceConfiguration(String uid, String cid) Creates a new ServiceConfiguration instance with provided unique and content IDs.

Method Summary

	boolean	equals(Object o) Determines if another object is identical to this service configuration.
	String	getCID() Retrieves the CID of this service.
	String	getEmailAddress() Retrieves the email address associated with this service.
	String	getName() Retrieves name of the service record held in this configuration.
	String	getUID() Retrieves the UID for this service.
	int	hashCode() Retrieves this service configuration's IDs as a hash.
	String	toString() Retrieves string representation of this configuration.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

NO_SERVICE_BOOK

public static String NO_SERVICE_BOOK

Names the root folder for folders belonging to a hierarchy without a corresponding service book entry.

Since:

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

Constructor Detail

ServiceConfiguration

public ServiceConfiguration()

Creates a new ServiceConfiguration instance.

Since:

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

ServiceConfiguration

public ServiceConfiguration(String uid,
                            String cid)
                     throws NoSuchServiceException

Creates a new ServiceConfiguration instance with provided unique and content IDs.

Parameters:

uid - Service UID, as displayed in the Options > Service Book screen.

cid - Service CID, as displayed in the Options > Service Book screen.

Throws:

NoSuchServiceException - If no matching service exists.

Since:

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

ServiceConfiguration

public ServiceConfiguration(ServiceRecord sr)

Creates a new ServiceConfiguration instance with provided service record.

Parameters:

sr - Service record used to create the new service configuration.

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

getUID

public String getUID()

Retrieves the UID for this service.

Returns:

Service's unique ID (UID) as a string.

Since:

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

getCID

public String getCID()

Retrieves the CID of this service.

Returns:

Service content ID (CID) as a string.

Since:

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

equals

public boolean equals(Object o)

Determines if another object is identical to this service configuration.

Overrides:

equals in class Object

Parameters:

o - Object to compare to this service configuration.

Returns:

True if provided object is the same object as this instance, or if provided object is a ServiceConfiguration and contains the same data as this instance; otherwise, false.

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.

hashCode

public int hashCode()

Retrieves this service configuration's IDs as a hash.

Overrides:

hashCode in class Object

Returns:

Hash of this configuration's IDs.

Since:

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

getName

public String getName()

Retrieves name of the service record held in this configuration.

Returns:

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

Since:

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

getEmailAddress

public String getEmailAddress()

Retrieves the email address associated with this service.

Returns:

Email address associated with this service.

Since:

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

toString

public String toString()

Retrieves string representation of this configuration.

Use this method to retrieve a string of the form:

   ServiceRecordName:UID:CID
 

Overrides:

toString in class Object

Returns:

String representation of this configuration.

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.