---

Overview  Package    Class   Use  Tree  Serialized  Deprecated  Index  Help		Mobile Tools for Java Release 1.0
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR |  METHOD	DETAIL: FIELD | CONSTR |  METHOD

---

org.eclipse.mtj.core.sdk.device
Interface IAPI

All Superinterfaces:

IPersistable

All Known Subinterfaces:

IMIDPAPI

---

public interface IAPI
extends 
IPersistable

This interface represent a API that is provided by one specific device.

Since:

1.0

Restriction:

This interface is not intended to be implemented by clients.

---

Field Summary

 

Fields inherited from interface org.eclipse.mtj.core.persistence. IPersistable
CLASS_PERSISTABLE_ATTRIBUTE, ID_PERSISTABLE_ATTRIBUTE, KEY_PERSISTABLE_ATTRIBUTE, PROPERTY_PERSISTABLE_ELEMENT, REFID_PERSISTABLE_ATTRIBUTE, VALUE_PERSISTABLE_ATTRIBUTE

 

Method Summary
String	getIdentifier ()           Returns the API identifier.
String	getName ()           Returns the API name.
Version	getVersion ()           Returns the API version in OSGi format.
void	setIdentifier ( String identifier)           Sets the API identifier.
void	setName ( String name)           Sets the API Name.
void	setVersion (Version version)           Sets the API version.
String	toString ()           Returns a string representation of the API.

 

Methods inherited from interface org.eclipse.mtj.core.persistence. IPersistable
loadUsing, storeUsing

 

Method Detail

getIdentifier

String getIdentifier()

Returns the API identifier. For example, if a device support WMA version 1.1, this method should return "WMA" as identifier.

Returns:

API identifier.

---

getName

String getName()

Returns the API name. For example, if a device support WMA version 1.1, this method should return "Wireless Messaging API".

Returns:

the API name

---

getVersion

Version getVersion()

Returns the API version in OSGi format. For example, if a device support WMA version 1.1, this method should return 1.1.0

Returns:

the version for this API.

---

setIdentifier

void setIdentifier(
String identifier)

Sets the API identifier. For example, if a device support WMA version 1.1, "WMA" should be use as identifier.

Parameters:

identifier - the API identifier.

---

setName

void setName(
String name)

Sets the API Name. For example, if a device support WMA version 1.1, "Wireless Messaging API" should be used as name.

Parameters:

name - API name

---

setVersion

void setVersion(Version version)

Sets the API version.

Parameters:

version - API Version.

---

toString

String toString()

Returns a string representation of the API. The API will be represented by both the name and version concatenated with a -. For example if the device support WMA version 1.1, the method will return WMA-1.1

Overrides:

toString in class Object

Returns:

a string representation of the API.

---

Overview  Package    Class   Use  Tree  Serialized  Deprecated  Index  Help		Mobile Tools for Java Release 1.0
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR |  METHOD	DETAIL: FIELD | CONSTR |  METHOD

---