See: Description
Class | Description |
---|---|
ByTargetResponse |
Data from the
bytarget command, can be accessed by pzresp.byTarget |
CommandError |
Holds an error encountered during the execution of a command.
|
Hit |
Data from the
show command, child object of ShowResponse, can be accessed by pzresp.show.hits |
InitResponse |
Data from the
init command, can be accessed by pzresp.init |
Location |
Data from the
show command, child object of Hit |
RecordResponse |
Data from the
record command, can be accessed by pzresp.record |
ResponseDataObject |
Parent class of all response data objects, with generic methods for retrieving data elements
|
ResponseParser |
Parses the XML stored in ClientCommandResponses and builds ResponseDataObjects from it.
|
Responses |
Provides references to all current data objects and has general methods for clearing certain response data.
|
SearchResponse |
Data from the
search command (a status message), can be accessed by pzresp.search |
ServiceError | |
ShowResponse |
Data from the
show command, can be accessed by pzresp.show |
StatResponse |
Data from the
stat command, can be accessed by pzresp.stat |
Target |
Data from the
bytarget command, child object of ByTargetResponse |
TermListResponse |
Data from the
termlist command, child object of TermListsResponse |
TermListsResponse |
Data from the
termlist command, can be accessed by pzresp.termLists |
TermResponse |
Data from the
termlist command, child object of TermListResponse |
TermXTargetResponse |
Data from the
termlist command, child object of TermListResponse |
Responses is exposed to the UI as pzresp
Examples:
pzresp.show.hits returns a list of hits from the most recent show command
pzresp.show.hits.[0]
returns the first hitpzresp.show.hits.[0].author
returns the author attribute of the first hitpzresp.show.hits.[0].getOneValue("my-hit-field")
returns an arbitrary attribute of the data object