viv:vivisimo-xml

returns XML information giving the current state of a Watson Explorer Engine object

Synopsis

node-set
viv:vivisimo-xml
(v, stringout, type, state);
string    v;
int       stringout;
string    type;
string    state;

Returns XML corresponding to the current state of a Watson Explorer Engine object

vobj: the reference string of a Watson Explorer Engine object (see viv:vivisimo-alloc). If empty, the current Watson Explorer Engine object is used.
stringout: (int) used as a Boolean, this parameter determines whether a string or XML nodeset is returned by this function. Using a string can be more efficient than using an XML node in some cases. If "true" (1), a string is returned; if false (0), an XML node is returned. The default value for this parameter is "false".
type: determines the sort of information returned by this function, one of the following:
- full-state: all of the XML in the object
- browsing-state: a state corresponding to the state passed as the state parameter to this function. This is similar to the XML that is produced by the query-meta application when v:xml=1 and v:state=state are set.
- process-state: the XML that is currently being processed in the object (in other words, all ongoing requests)
- processed-state: the XML that has already been processed in the object (in other words, full-state minus process-state)
state: the state that is used to calculate the browsing-state. New values are calculated in the browsing-state so that they can be passed back in response to certain actions, such as when clicking on a cluster. The value root|root represents the original state.

a node containing the current state of v