Roadmap to PODS interfaces

This section summarizes the functionality provided by each M-Business client extension API (PODS) interface. From these summaries, you should be able to determine which interface you need to use to implement which types of application tasks in PODS.

Note

To quickly determine which PODS objects are exported to M-Business JavaScript engine, refer to PODS interface inheritance.

Object-related and top-level objects:

  • PODSObject is the basic interface of all PODS objects. The PODSObject object is used occasionally in function prototypes to refer to an object with a generic type. See PODSObject object.

  • A PODSObjectSrc object implements objectForName(), which returns a PODSObject for a specified name. See PODSObjectSrc object.

  • The PODSObjectMgr object manages the PODSObjectSrc objects associated with a POD. It checks to see if a PODSObject implements a specific interface. See PODSObjectMgr object.

  • PODSAvantGo object represents the M-Business application. You can get several important PODS objects (PODSMemoryMgr, PODSSubmissionMgr, PODSObjectMgr, etc.) from the PODSAvantGo object. See PODSAvantGo object.

  • A PODSPod object represents a loaded POD. The interface has methods to get the POD's description and version. See PODSPod object.

  • The PODSMemoryMgr provides memory management tools that are needed by PODs. See PODSMemoryMgr object.

  • A PODSArray object is an array that is passed between PODS and JavaScript. See PODSArray object.

Document-related objects:

  • A PODSDocument represents one document in the system, which can be an HTML page, an image, or a script. PODSDocument allows you to access all the document attributes. See PODSObject object.

  • A PODSDocumentSrc vends documents in response to URLs. PODSDocumentSrcs are registered with the PODSDocumentMgr. See PODSDocumentSrc object.

  • A PODSDocumentEnumerator is used to enumerate the documents available from the PODSDocumentSrc that vended it. See PODSDocumentEnumerator object.

  • The PODSDocumentMgr method registers, unregisters, and creates PODSDocumentSrc objects. See PODSDocumentMgr object.

DOM-related objects:

  • The ADOMObject interface includes attributes and methods that implement most of the Worldwide Web Consortium (W3C) document object model (DOM) level 1 specification. See ADOMDOMImplementation object.

Submission-related objects:

  • A PODSSubmissionElement represents a name-value pair in a PODSSubmission object. See PODSObject object.

  • A PODSSubmission represents a form submission request. It also allows creation of its own submission elements. See PODSSubmission object.

  • The PODSSubmissionMgr manages the form submissions. You usually use this object only when creating or deleting a PODSSubmission object programmatically. See PODSSubmissionMgr object.

Browser-related objects:

  • A PODSButton represents a button in the M-Business Client toolbar. PODSButton is the full interface that is available to PODS to manipulate the M-Business Client toolbar. See PODSButton object.

  • The PODSToolbar represents the M-Business Anywhere client toolbar. See PODSToolbar object.

  • A PODSWindow object represents the M-Business Anywhere client browser window. Equivalent to JavaScript Window object. See PODSObject object.

  • A PODSHistory represents the user's browser history and navigates to specified points within that browse history. Equivalent to JavaScript History object. See PODSHistory object.

  • The PODSLocation object represents the location of the page currently being displayed in the M-Business Anywhere client browser. Equivalent to JavaScript Location object. See PODSLocation object.

Miscellaneous objects:

  • The PODSScreen object accesses information about the screen on which the M-Business Anywhere client is running. Equivalent to JavaScript Screen object. See PODSScreen object.

  • The PODSPrefs object represents the set user preferences on M-Business Anywhere client. See PODSPrefs object.

  • The PODSNavigator object returns information about the M-Business Anywhere client browser application. Equivalent to JavaScript Navigator object. See PODSNavigator object.

  • The PODSSymbolScanner object provides the API for working with a Symbol Technologies bar-code scanner device. See PODSSymbolScanner object.

Event and exception objects:

  • A PODSEventHandler object handles OS events. See PODSObject object.

  • The PODSEventMgr manages events. You register and unregister event handlers with the PODSEventMgr. See PODSEventMgr object.

  • A PODSException represents a thrown exception. See PODSException object.

  • The PODSExceptionMgr provides JavaScript-compatible exception handling for PODS, including the ability to throw an exception to be caught in M-Business JavaScript engine. See PODSExceptionMgr object.