Package com.storedobject.core

Class JSONPrompt

java.lang.Object

com.storedobject.core.JSONPrompt

All Implemented Interfaces:

JSONService

public class JSONPrompt
extends Object
implements JSONService

Constructor Summary

Constructors

Constructor	Description
JSONPrompt()

Method Summary

Modifier and Type	Method	Description
final void	addPrompt(String prompt)
final void	addPrompt(String type, String prompt)
final void	execute(Device device, JSON json, JSONMap result)	This method should be implemented to serve the connector API call.
protected String	getTemplate()	Retrieves the template string associated with the current MCP request.
protected Object	getValue(JSON parameters, String parameter)
protected void	process(Device device, JSON parameters)
void	set(String template, Map<String,Method> methods)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JSONPrompt

public JSONPrompt()

Method Details

execute

public final void execute(Device device,
 JSON json,
 JSONMap result)

Description copied from interface: JSONService

This method should be implemented to serve the connector API call. It carries out the execution logic of the call.

Specified by:

execute in interface JSONService

Parameters:

device - Device on which the call is made.

json - JSON request object received from the device.

result - A JSONMap where response data is inserted. To highlight an error, respond with JSONMap.error(String).

process

protected void process(Device device,
 JSON parameters)

getValue

protected Object getValue(JSON parameters,
 String parameter)

addPrompt

public final void addPrompt(String prompt)

addPrompt

public final void addPrompt(String type,
 String prompt)

set

public void set(String template,
 Map<String,Method> methods)

getTemplate

protected String getTemplate()

Retrieves the template string associated with the current MCP request. Overriding classes may return a custom template string based on the business logic.

Returns:

the template string from the request, or null if no template is defined.