9.5

example, if the name of the property is "quality," the default accessor method is
getQuality).
•
mutator: The name of the accessor that sets the property. If this value is null, the
default mutator name is used. The default name is "set" + CamelCase(name) (for
example, if the name of the property is "quality," the default mutator method is
setQuality).
•
description: A description of the attribute. Unless this value is null, the description
is included in variable headers and accessor and mutator headers and is included in
generated API docs.
•
type: The type of the class variable. If this value is null, the default type (string)
is used. If this is not a primitive data type, it should be defined as a separate Class
element. If this attribute has a value of "reference," it means the class defined by name
is a reference that will be used by a reference attribute in the same Class element.
Before serialization, the referring values are set in this instance.
•
reference: Unless this attribute has a null value, during serialization the value of
the field should be set in the reference class provided. Note that the reference class
should be declared using "type=reference" as explained above.
•
readonly: If this value is true, this field is for read-only purposes and should be
ignored during serialization.
•
hidden: If this value is true, this field should be generated as a private variable. As
such, it would not be included in WSDL.
•
deprecated: If this value is true, this field has been deprecated, should not be used,
is not supported, and will be removed in a future version of QuarkXPress Server.
•
cdata: If this value is true, the value of this field is to be wrapped in a cdata section
before being sent to QuarkXPress Server. This is valid only if the field is "value", that
is value of the element in modifier XML.
•
<others>: If any other attributes are defined, a class field with the name as
<name>_<others> is created, and you can write your own implementation for it.
Using the RequestParameters class
RequestParameters is a generic request class that can be used in lieu of any class, existing
or otherwise.
RequestParameters has a namespace property, which can be used to send any request. For
example:
RequestParameters requestParameters = new RequestParameters();
requestParameters.setRequestNamespace("jpeg");
It also has an array of dynamic parameters, which can be used to parameterize the request.
For example:
NameValueParam param = new NameValueParam();
param.setParamName("scale");
param.setTextValue("1");
requestParameters.setParams(new NameValueParam[]{param });
182 | A GUIDE TO QUARKXPRESS SERVER 9.5
USING QUARKXPRESS SERVER