net.rim.device.api.io.transport
Class TransportDescriptor

java.lang.Object
  net.rim.device.api.io.transport.TransportDescriptor

public class TransportDescriptor
extends Object

This class encapsulates information related to a specific transport instance. It includes the transportType and identifiers for the corresponding ServiceRecord (if available) for the transport.

Instances of this class are obtained via the methods in TransportInfo (e.g. getTransportDescriptor())

See Also:

ServiceRecord, TransportInfo

Since:

BlackBerry API 5.0.0

Constructor Summary

TransportDescriptor(int transportType, ServiceRecord serviceRecord)
Creates a TransportDescriptor for the specified transportType with the specified ServiceRecord.

Method Summary
String	getCid() Retrieves the CID of the ServiceRecord for the transport instance represented by this descriptor (if available)
int	getTransportType() Retrieves the transportType encapsulated by this descriptor
String	getUid() Retrieves the UID of the ServiceRecord for the transport instance represented by this descriptor (if available)
void	setCid(String cid) Sets the CID of the ServiceRecord for the transport instance represented by this descriptor (if available)
void	setTransportType(int transportType) Sets the transportType in the descriptor
void	setUid(String uid) Sets the UID of the ServiceRecord for the transport instance represented by this descriptor (if available)

Methods inherited from class java.lang.Object

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

Constructor Detail

TransportDescriptor

public TransportDescriptor(int transportType,
                           ServiceRecord serviceRecord)

Creates a TransportDescriptor for the specified transportType with the specified ServiceRecord. Note: This constructor should not be used directly; instead, instances of this class are obtained via the methods in TransportInfo (e.g. getTrasnportDescriptor())

Parameters:

transportType - One of the TRANSPORT_* defined in TransportInfo

serviceRecord - The ServiceRecord for the specified transport.

Since:

BlackBerry API 5.0.0

Method Detail

getTransportType

public int getTransportType()

Retrieves the transportType encapsulated by this descriptor

Returns:

the transportType encapsulated by this descriptor

Since:

BlackBerry API 5.0.0

setTransportType

public void setTransportType(int transportType)

Sets the transportType in the descriptor

Parameters:

transportType - the transportType to set

Since:

BlackBerry API 5.0.0

getUid

public String getUid()

Retrieves the UID of the ServiceRecord for the transport instance represented by this descriptor (if available)

Returns:

a String representing the UID of the ServiceRecord for the transport instance represented by this descriptor; or null otherwise.

Since:

BlackBerry API 5.0.0

setUid

public void setUid(String uid)

Sets the UID of the ServiceRecord for the transport instance represented by this descriptor (if available)

Since:

BlackBerry API 5.0.0

getCid

public String getCid()

Retrieves the CID of the ServiceRecord for the transport instance represented by this descriptor (if available)

Returns:

a String representing the CID of the ServiceRecord for the transport instance represented by this descriptor; or null otherwise.

Since:

BlackBerry API 5.0.0

setCid

public void setCid(String cid)

Sets the CID of the ServiceRecord for the transport instance represented by this descriptor (if available)

Since:

BlackBerry API 5.0.0