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 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:
JDE 3.6.0

Field Summary
 Category: Signed static String NO_SERVICE_BOOK
          Names the root folder for folders belonging to a hierarchy without a corresponding service book entry.
 
Constructor Summary
 Category: Signed ServiceConfiguration()
          Creates a new ServiceConfiguration instance.
 Category: Signed ServiceConfiguration(ServiceRecord sr)
          Creates a new ServiceConfiguration instance with provided service record.
 Category: Signed ServiceConfiguration(String uid, String cid)
          Creates a new ServiceConfiguration instance with provided unique and content IDs.
 
Method Summary
 Category: Signed  boolean equals(Object o)
          Determines if another object is identical to this service configuration.
 Category: Signed  String getCID()
          Retrieves the connection ID (CID) of this service.
 Category: Signed  String getEmailAddress()
          Retrieves the email address associated with this service.
 Category: Signed  String getName()
          Retrieves the name of the service record held in this configuration.
 Category: Signed  String getUID()
          Retrieves the UID for this service.
 Category: Signed  int hashCode()
          Retrieves this service configuration's IDs as a hash.
 Category: Signed  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 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.
Constructor Detail

ServiceConfiguration

public ServiceConfiguration()
Creates a new ServiceConfiguration instance.
Since:
JDE 3.6.0
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.

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

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 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.
Method Detail

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 3.6.0
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.

getCID

public String getCID()
Retrieves the connection ID (CID) of this service. The CID identifies the connection type of a service. The CID is case-insensitive and must be between 1 and 127 bytes in length See the BlackBerry Application Developer Guide Volume 2: Advanced Topics for more information.
Returns:
Service content ID (CID) as a string.
Since:
JDE 3.6.0
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.

getEmailAddress

public String getEmailAddress()
Retrieves the email address associated with this service. Queries a service record for the email address the server has assigned to the BlackBerry device. This data is useful if you want to determine the email address that is associated to the email service for a particular BlackBerry device.
Returns:
Email address associated with this service.
Since:
JDE 3.6.0
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.

getName

public String getName()
Retrieves the name of the service record held in this configuration. This information can be used to later find a service using its Name.
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 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.

getUID

public String getUID()
Retrieves the UID for this service. The UID is a string that uniquely identifies a service. The UID is case-insensitive and must be between 1 and 127 bytes in length
Returns:
Service's unique ID (UID) as a string.
Since:
JDE 3.6.0
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.

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

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



Copyright 1999-2009 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.