10.2.1

These classes can be chained together to form compound QuarkXPress Server requests.
The sample applications (see "Sample applications") show how to use these classes to
invoke a QuarkXPress Server command and manipulate the response.
For more information, see "Using the Web interface." In addition to the classes listed
there, the Web services interface includes the following:
•
RequestService processes QuarkXPress Server requests. This object's generic
processRequest() method takes a QRequestContext argument and returns a
QContentData object containing the response. For more information, see the sample
applications and "Using the Web interface."
•
QRequestContext is the argument you pass to RequestService's generic
processRequest() method.This object contains settings which must be set once per
request. Set all chained requests inside the request context.
•
QRequest is the base class for all request objects (such as PDFRenderRequest).
Consequently, all request objects share some common data members.
•
RequestParameters is a generic class for executing any request and for adding
dynamic properties to a request.
•
NameValueParam is a generic class for adding dynamic properties to a request. This
class is specifically for requests that take a box's name and/or ID as the parameter name
and the box's content as the value.
•
QContentData is the response returned when a request is executed. QContentData
is a hyperlink that follows the same pattern as the classes above.
•
QException is the exception class for QuarkXPress Server Manager. Web services
returns a QException object if an error occurs with any Web service method. You
can use try/catch blocks to handle QException objects.
If you've written a Server XTensions module, you can extend the XML interface to
include any changes it makes to the Modifier DTD by simply modifying an XML file
and regenerating the stubs.
To exclude empty tags in the request HTML, set the value of the appropriate variable
to null.
For Javadocs, WSDL schemas, and JSP samples, see the Welcome page that displays
when you launch QuarkXPress Server Manager.
The following topics describe the general Web services classes.
QRequestContext
An argument passed to RequestService. Contains settings that must be set once per request.
All chained requests must be set inside the request context.
Description
Web service data objectType
DescriptionTypes
NameMembers
File or object name on which the command will be rendered.String
documentName
42 | A GUIDE TO QUARKXPRESS SERVER 10.2.1
USING QUARKXPRESS SERVER