API Overview
The Application Programming Interface (API) for Handheld Applications offers base services to Mobile applications running on an SAP NetWeaver Mobile Client for Handhelds. This API is mainly used by the generated code of mobile service and UI components and major parts are usually not relevant for application developers.
Apart from the API offered by the client runtime itself, there is also an API of your mobile service components that is automatically created when you generate the component. It allows you to access data objects, service operations and so forth. Since it is dynamically created during generation and specific to your application, it is not part of the Javadoc. Nonetheless, the API is fully accessible through code completion of your Java Editor just like the rest of the client API.
You can find the implementation of the generated classes in the Resource perspective of SAP NetWeaver Developer Studio in folder gen_oca. These classes are part of the public part of the Mobile Service Component and are fully accessible from the Mobile UI Component. As an example, you can view the convenience methods that are generated in the component controller after the component controller template Mobile Service Component has been applied. A similar use can also be found in section Custom Methods of the tutorial.
The table below gives you an overview and a brief description of some important APIs you can use in your application development:
API Service |
Description |
Package |
Business Logic |
The Business Logic API provides access to the business logic provided by the mobile service component. The API is mainly used by the generated code of the mobile service component and you as developer will rather access data (such as data objects, data structures, services, and queries) through the generated classes instead. Central access class is OcaRoot. |
com.sap.tc.mobile.sf com.sap.tc.mobile.sf.api com.sap.tc.mobile.wdlite.ocaexceptions |
User Interface |
The User Interface API is mainly used by the generated code of the mobile UI component. In exceptional cases, where the runtime UI is changed towards the UI modeled at design time, the API can be used to adapt the meta-model at runtime. An example could be that based on a situation, in which a button or table column is dynamically hidden. |
com.sap.tc.mobile.wdlite.progmodel.api com.sap.tc.mobile.wdlite.progmodel.core com.sap.tc.mobile.wdlite.progmodel.core.context com.sap.tc.mobile.wdlite.progmodel.core.viewelement com.sap.tc.mobile.wdlite.progmodel.core.viewitem com.sap.tc.mobile.wdlite.progmodel.util com.sap.tc.cmi.metadata com.sap.tc.cmi.model com.sap.tc.mobile.wdlite.util |
Synchronization |
Synchronization results incl. rejected data is accessed through this API. |
com.sap.tc.mobile.sf.api.sync |
Deployment |
The API provieds access to information about deployment status of mobile components. |
com.sap.tc.mobile.sf.api.deploy |
User Management |
Information about the current device user can be accessed here. |
com.sap.tc.mobile.sf.api.user |