com.sap.tc.webdynpro.progmodel.api

Interface IWDApplicationHandle

public interface IWDApplicationHandle

Handle to an embedded application. This handle allows an embedding application to control the life cycle of an embedded application. It furthermore is used to bind the visual part of an embedded application to IWDApplicationContainer UI elements.

Type Classification:

This interface is part of the Web Dynpro API, so applications may reference it or call any method of it, but they must not implement or extend it.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IWDApplicationHandle.WDApplicationState State of the application.
static class	IWDApplicationHandle.WDCallExecutionMode Execution mode of a method call.

Method Summary

Modifier and Type	Method and Description
IWDApplicationHandle.WDCallExecutionMode	destroy() Requests to terminate and destroy the embedded application.
IWDApplicationHandle.WDApplicationState	getState() Retrieves the current state of the embedded application.
String	getTitle()
boolean	hasQueuedRequest() Information, whether there is a queued request.
IWDApplicationHandle.WDCallExecutionMode	resume(Map<String,? extends Object> resumeParameters) Requests to resume the embedded application.
IWDApplicationHandle.WDCallExecutionMode	start(Map<String,? extends Object> startParameters) Requests to start the embedded application.
IWDApplicationHandle.WDCallExecutionMode	suspend() Requests to suspend the embedded application.

Method Detail

getState

IWDApplicationHandle.WDApplicationState getState()

Retrieves the current state of the embedded application.

Returns:

State of the embedded application.

start

IWDApplicationHandle.WDCallExecutionMode start(Map<String,? extends Object> startParameters)

Requests to start the embedded application. State dependent behavior and return value:

• INITIAL: start application (DIRECT)
• IDLE: ignore call (NO_OP)
• PROCESSING: ignore call (NO_OP)
• SUSPENDED: ignore call (NO_OP)
• DESTROYED: ignore call (NO_OP)

Parameters:

startParameters - All parameters are passed as request parameters and parameters with matching name are also passed as start plug parameters.
The values must either be of type String, or of type array of String. The values must neither be null nor empty arrays.
If an array is passed, a corresponding start plug gets the first element of the array as parameter. startParameters may be null or an empty map. The keys in the map must not be null.

Returns:

the execution mode of this call

suspend

IWDApplicationHandle.WDCallExecutionMode suspend()

Requests to suspend the embedded application. State dependent behavior and return value:

• INITIAL: ignore call (NO_OP)
• IDLE: suspend application (DIRECT)
• PROCESSING: if possible queue request until state changes (QUEUED / DROPPED)
• SUSPENDED: ignore call (NO_OP) / ignore queued request
• DESTROYED: ignore call (NO_OP) / ignore queued request

Returns:

the execution mode of this call

resume

IWDApplicationHandle.WDCallExecutionMode resume(Map<String,? extends Object> resumeParameters)

Requests to resume the embedded application. State dependent behavior and return value:

• INITIAL: ignore call (NO_OP)
• IDLE: ignore call (NO_OP) / ignore queued request
• PROCESSING: if possible queue request until state changes (QUEUED / DROPPED)
• SUSPENDED: resume application (DIRECT)
• DESTROYED: ignore call (NO_OP) / ignore queued request

Parameters:

resumeParameters - All parameters are passed as request parameters and parameters with matching name are also passed as resume plug parameters.
The values must either be of type String, or of type array of String. The values must neither be null nor empty arrays.
If an array is passed, a corresponding resume plug gets the first element of the array as parameter.
resumeParameters may be null or an empty map. The keys in the map must not be null.

Returns:

the execution mode of this call

destroy

IWDApplicationHandle.WDCallExecutionMode destroy()

Requests to terminate and destroy the embedded application. State dependent behavior and return value:

• INITIAL: terminate application (DIRECT)
• IDLE: terminate application (DIRECT)
• PROCESSING: if possible queue request until state changes (QUEUED / DROPPED)
• SUSPENDED: ignore call (NO_OP) / ignore queued request
• DESTROYED: ignore call (NO_OP) / ignore queued request

Returns:

the execution mode of this call

hasQueuedRequest

boolean hasQueuedRequest()

Information, whether there is a queued request.

Returns:

true, iff a method call has returned IWDApplicationHandle.WDCallExecutionMode.QUEUED and this request is still in the queue.

getTitle

String getTitle()

Returns:

the current title string of the embedded application.