SHOW Signed

net.rim.blackberry.api.mail
Class Service

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

Direct Known Subclasses:

Store, Transport

public abstract class Service

extends Object

Represents an email service on the handheld.

The default service is implicitly connected.

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

See Also:

Transport, Store, ServiceConfiguration

Method Summary

	void	addServiceListener(ServiceListener sl) Registers a service listener to handle service events for this server.
	ServiceConfiguration	getServiceConfiguration() Retrieves the service configuration for the current email service.
	boolean	isConnected() Determines whether this service is connected.
	void	removeServiceListener(ServiceListener sl) De-registers a service listener.
	void	setConnected(boolean connected) Sets the connection status of a service.
	String	toString() Retrieves a human-readable string for this service.

Methods inherited from class java.lang.Object

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

Method Detail

isConnected

public boolean isConnected()

Determines whether this service is connected.

Returns:

True if the service is connected; otherwise, false.

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.

setConnected

public void setConnected(boolean connected)

Sets the connection status of a service.

Parameters:

connected - True to connect the service; false to disconnect the 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 a human-readable string for this service.

By default, this method returns an empty string; implementing subclasses should override this to provide more specific information.

Overrides:

toString in class Object

Returns:

A human-readable string that describes 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.

getServiceConfiguration

public ServiceConfiguration getServiceConfiguration()

Retrieves the service configuration for the current email service.

By default, this method returns null; implementing subclasses should override this to provide more specific functionality..

Returns:

Service configuration for the currrent email address service, or null if no configuration available.

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.

addServiceListener

public void addServiceListener(ServiceListener sl)

Registers a service listener to handle service events for this server.

Service listeners are invoked when something in the service changes, such as the addition or removal of a Folder.

Parameters:

sl - Service listener to register.

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.

removeServiceListener

public void removeServiceListener(ServiceListener sl)

De-registers a service listener.

Parameters:

sl - Service listener to de-register.

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.