1
2 /*!
3 * ======== ViewXml ========
4 * This module sits on top of the ROV core to convert ROV views into
5 * XML. This is useful for test scripts and command-line based ROV tools.
6 */
7 metaonly module ViewXml {
8
9 /*!
10 * ======== processCommand ========
11 * This API allows the client to interact with the ROV core and retrieve
12 * ROV views.
13 *
14 * It takes String commands of the following forms.
15 * 1. "lm" - List Modules.
16 * This returns an XML list of all of the modules in the executable's
17 * configuration and the views they support.
18 * 2. "m <module name> <tab name>" - Retrieve tab view for module.
19 * 3. "cc" - Clear cache.
20 * This command clears the ROV core's cache of views. This command
21 * should be sent whenever the target state changes.
22 */
23 String processCommand(String cmd);
24
25 /*!
26 * ======== listModules ========
27 * Returns the list of modules in XML form.
28 */
29 String listModules();
30
31 /*!
32 * ======== retrieveView ========
33 * Retrieves the view in XML form for the given module and tab.
34 */
35 String retrieveView(String modName, String tabName);
36 }
37 38 39
40