Skip to content
pCon.configurator onlineDocumentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

OAPClientCapability

Synopsis

enum OAPClientCapability {
    MultiActionChoice,
    PlanningMode
}

A set of values of this enumeration is used to specify OAP-related capabilities of the client. There is one value for each capability. The client calls operation oapSetClientCapabilities (§ OapSetClientCapabilities) to inform the server about the capabilities it supports.

No new capability will be defined for new server-side OAP features if they only results in new data being returned to the client that can safely be ignored1.

The current version of EAIWS defines the following capabilities:

MultiActionChoice

Staring with OAP draft 16, OAP action list items (henceforth called action choices) contain a list of action IDs instead of a single action ID.

If the MultiActionChoice capability has not been set then no OAPActionListItem is returned for an action choice that contains multiple action IDs, or for an action choice with a single action ID if the referenced action is inactive. The action-field of OAPActionListItem always contains the complete action data.

If capability MultiActionChoice has been set then an OAPActionListItem is returned for each visible action choice2. Field action of OAPActionListItem is missing. Instead, field actionIds is used to return one or more action IDs (which may reference inactive actions3). Once an action choice has been selected the corresponding list of action IDs can be processed with operation oapProcessActions.

PlanningMode

Starting with OAP draft 16, interactor definitions contain a flag that indicates whether or not the actions attached to the interactor require the user interface to support planning mode. Supporting planning mode means that the user interface is able to simultaneously display, and allow interaction with, multiple top-level objects.

If OAP client capability PlanningMode has not been set then the server does not return interactors that require the user interface to support planning mode according to the aforementioned flag. If capability PlanningMode has been set then all active interactors are returned.

Footnotes

  1. Clients are expected to ignore data returned with unknown XML attributes and elements. ↩

  2. as determined by the new (optional) condition of the action choice ↩

  3. Action choices with no condition, or with a satisfied condition, are expected to reference at least one active action ↩