Janus SOAP XmlDoc API V7.8 changes - Revision history

Admin: Replaced content with "Content moved to M204Int, but history preserved here."

2013-10-17T21:34:02Z

Replaced content with "Content moved to M204Int, but history preserved here."

JAL2: /* AddToRecordError exception class */

2012-06-29T21:46:10Z

AddToRecordError exception class

← Older revision		Revision as of 21:46, 29 June 2012
Line 633:		Line 633:

	===AddToRecordError exception class===		===AddToRecordError exception class===
	The members of the <var>AddToRecordError</var> exception class are described below.		The members of the <var>[[AddToRecordError class\|AddToRecordError]]</var> exception class are described below.
	Except for the constructor, <var>New</var>, all class members are read-only properties:		Except for the constructor, <var>New</var>, all class members are read-only properties:
	<dl>		<dl>

JAL2: /* AddToRecordError exception class */

2012-06-29T21:40:48Z

AddToRecordError exception class

← Older revision		Revision as of 21:40, 29 June 2012
Line 637:		Line 637:
	<dl>		<dl>
	<dt>Reason		<dt>Reason
	<dd>An enumeration of type <var>AddToRecordErrorReason</var>.		<dd>An enumeration of type <var>[[AddToRecordError class#AddToRecordErrorReason enumeration\|AddToRecordErrorReason]]</var>.
	The possible values are:		The possible values are:
	<table>		<table>

JAL2: /* Structure of XmlDoc for AddToRecord */

2012-06-29T21:37:02Z

Structure of XmlDoc for AddToRecord

← Older revision		Revision as of 21:37, 29 June 2012
Line 568:		Line 568:
	</th><td>Comment and PI nodes are allowed anywhere in the <var>XmlDoc</var>.		</th><td>Comment and PI nodes are allowed anywhere in the <var>XmlDoc</var>.
	</td></tr>		</td></tr>
	<tr><th>Elements in non-null namespaces		<tr><th nowrap>Elements in non-null namespaces
	</th><td>In addition to the elements mentioned below for the various elements contained in the <var>XmlDoc</var>, the <code>Record</code> and <code>fieldgroup</code> elements may have any additional child elements that are in any non-null namespace. These additional elements are ignored. For example, the following is a valid <var>AddToRecord</var> <var>XmlDoc</var> representing an empty record:		</th><td>In addition to the elements mentioned below for the various elements contained in the <var>XmlDoc</var>, the <code>Record</code> and <code>fieldgroup</code> elements may have any additional child elements that are in any non-null namespace. These additional elements are ignored. For example, the following is a valid <var>AddToRecord</var> <var>XmlDoc</var> representing an empty record:
	<p class="code"><nowiki><Record>		<p class="code"><nowiki><Record>
Line 602:		Line 602:
	</th><td>If present, this attribute contains the name of the codepage whose base translation tables are used for converting the Unicode field names and field values (if not base 64 encoded) in the <var>XmlDoc</var> to EBCDIC.		</th><td>If present, this attribute contains the name of the codepage whose base translation tables are used for converting the Unicode field names and field values (if not base 64 encoded) in the <var>XmlDoc</var> to EBCDIC.
	</td></tr>		</td></tr>
	<tr><th>maxGroupID attribute of Record element		<tr><th nowrap>maxGroupID attribute of Record element
	</th><td>If present, this attribute contains the value of the maximum fieldgroup ID to be set (if greater than or equal to all of the fieldgroup IDs stored in the record) in the added record, if the <code>CopyIDs=True</code> argument is provided. This must be a non-negative integer value.		</th><td>If present, this attribute contains the value of the maximum fieldgroup ID to be set (if greater than or equal to all of the fieldgroup IDs stored in the record) in the added record, if the <code>CopyIDs=True</code> argument is provided. This must be a non-negative integer value.
	</td></tr>		</td></tr>
Line 631:		Line 631:
	</th><td>If present, this attribute contains the value of the fieldgroup ID to be set (if possible) for the fieldgroup occurrence in the added record, if the <code>CopyIDs=True</code> argument is provided.		</th><td>If present, this attribute contains the value of the fieldgroup ID to be set (if possible) for the fieldgroup occurrence in the added record, if the <code>CopyIDs=True</code> argument is provided.
	</td></tr></table>		</td></tr></table>

	===AddToRecordError exception class===		===AddToRecordError exception class===
	The members of the <var>AddToRecordError</var> exception class are described below.		The members of the <var>AddToRecordError</var> exception class are described below.

JAL2: /* MoveNamespace argument for AddTopElement */

2012-06-19T21:25:29Z

MoveNamespace argument for AddTopElement

← Older revision		Revision as of 21:25, 19 June 2012
Line 755:		Line 755:
	<var>Uri</var> argument, the declaration is deleted from the old top element.		<var>Uri</var> argument, the declaration is deleted from the old top element.

	Note: You should use <code>MoveNamespace=True</code> only when some consumer of		'''Note:''' You should use <code>MoveNamespace=True</code> only when some consumer of
	the XML document cares about not having the redundant declaration.		the XML document cares about not having the redundant declaration.
	This would be an unusual situation, because the information		This would be an unusual situation, because the information
Line 762:		Line 762:
	might trigger a scan of the entire <var>XmlDoc</var>, which <var>AddTopElement</var> does not		might trigger a scan of the entire <var>XmlDoc</var>, which <var>AddTopElement</var> does not
	normally do.		normally do.

	==DeleteTopElement subroutine in XmlDoc class==		==DeleteTopElement subroutine in XmlDoc class==
	The syntax for <var>DeleteTopElement</var> is:		The syntax for <var>DeleteTopElement</var> is:

JAL2 at 22:32, 2 June 2011

2011-06-02T22:32:13Z

← Older revision		Revision as of 22:32, 2 June 2011
Line 188:		Line 188:
	conformant to the XML Recommendation.		conformant to the XML Recommendation.

	See the description of the <var>~~AttributeValue~~</var> argument of the [[#LoadFromRecord subroutine in XmlDoc and XmlNode classes\|LoadFromRecord subroutine]] for a list of all conditions which force base64 encoding of the "field" element.</td></tr>		See the description of the <var>AttributeValues</var> argument of the [[#LoadFromRecord subroutine in XmlDoc and XmlNode classes\|LoadFromRecord subroutine]] for a list of all conditions which force base64 encoding of the "field" element.</td></tr>
	<tr><th>Other NewFromRecord arguments</th>		<tr><th>Other NewFromRecord arguments</th>
	<td>See [[#LoadFromRecord subroutine in XmlDoc and XmlNode classes\|LoadFromRecord]] for a discussion of all the other arguments of <var>NewFromRecord</var>.</td></tr>		<td>See [[#LoadFromRecord subroutine in XmlDoc and XmlNode classes\|LoadFromRecord]] for a discussion of all the other arguments of <var>NewFromRecord</var>.</td></tr>

Admin: /* AddToRecord subroutine in XmlDoc class */

2011-05-24T20:43:21Z

AddToRecord subroutine in XmlDoc class

← Older revision		Revision as of 20:43, 24 May 2011
Line 337:		Line 337:
	</td></tr>		</td></tr>
	<tr><th>DisableFieldConstraints		<tr><th>DisableFieldConstraints
	</th><td>This [[Methods#Named parameters\|name required]] argument is a <var>[[Boolean]]</var> value; if <var>True</var>, then various field constraints (such as LENGTH-EQ, which was introduced in <var class="product">Model 204</var> V7R2) are not checked when the fields are added to the record.		</th><td>This [[Methods#Named parameters\|name required]] argument is a <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var> value; if <var>True</var>, then various field constraints (such as LENGTH-EQ, which was introduced in <var class="product">Model 204</var> V7R2) are not checked when the fields are added to the record.

	The default is <var>False</var>.		The default is <var>False</var>.
Line 744:		Line 744:

	Note that this class was actually introduced in version 7.6 of the <var class="product">Sirius Mods</var>.		Note that this class was actually introduced in version 7.6 of the <var class="product">Sirius Mods</var>.

	==MoveNamespace argument for AddTopElement==		==MoveNamespace argument for AddTopElement==
	The following optional, [[Methods#Named parameters\|name required]] argument has been added to the		The following optional, [[Methods#Named parameters\|name required]] argument has been added to the

Admin: /* LoadFromRecord subroutine in XmlDoc and XmlNode classes */

2011-05-24T20:40:45Z

LoadFromRecord subroutine in XmlDoc and XmlNode classes

← Older revision		Revision as of 20:40, 24 May 2011
Line 257:		Line 257:
	</td></tr>		</td></tr>
	<tr><th>AttributeValues		<tr><th>AttributeValues
	</th><td>This [[Methods#Named parameters\|name required]] argument is a <var>[[Boolean]]</var> value that indicates whether a field value will be stored as “XML text” or as an XML attribute (belonging to its field, which is an <var>XmlDoc</var> element).		</th><td>This [[Methods#Named parameters\|name required]] argument is a <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var> value that indicates whether a field value will be stored as “XML text” or as an XML attribute (belonging to its field, which is an <var>XmlDoc</var> element).

	For example, <code><APSUBUND>COMM</APSUBUND></code> is text format, and <code><APSUBUND value="COMM"/></code> is attribute value format.		For example, <code><APSUBUND>COMM</APSUBUND></code> is text format, and <code><APSUBUND value="COMM"/></code> is attribute value format.
Line 273:		Line 273:
	</td></tr>		</td></tr>
	<tr><th>AttributeNames		<tr><th>AttributeNames
	</th><td>This [[Methods#Named parameters\|name required]] argument is a <var>[[Boolean]]</var> value that indicates whether each field name is to be stored in the <var>XmlDoc</var> as an element name or as the value of a "name" attribute.		</th><td>This [[Methods#Named parameters\|name required]] argument is a <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var> value that indicates whether each field name is to be stored in the <var>XmlDoc</var> as an element name or as the value of a "name" attribute.

	For example, <code><APSUBUND>COMM</APSUBUND></code> is element-name format, and the following is name-as-attribute format:		For example, <code><APSUBUND>COMM</APSUBUND></code> is element-name format, and the following is name-as-attribute format:
Line 314:		Line 314:
	This method was actually introduced in version 7.6 of		This method was actually introduced in version 7.6 of
	the <var class="product">Sirius Mods</var>, but the <var>XmlNode</var> class <var>LoadFromRecord</var> implementation prior to version 7.8 required that the <var>XmlDoc</var> be empty.		the <var class="product">Sirius Mods</var>, but the <var>XmlNode</var> class <var>LoadFromRecord</var> implementation prior to version 7.8 required that the <var>XmlDoc</var> be empty.

	==AddToRecord subroutine in XmlDoc class==		==AddToRecord subroutine in XmlDoc class==
	This subroutine adds to the current record the fields and/or fieldgroups		This subroutine adds to the current record the fields and/or fieldgroups

Admin: /* NewFromRecord shared function in XmlDoc class */

2011-05-24T20:39:08Z

NewFromRecord shared function in XmlDoc class

← Older revision		Revision as of 20:39, 24 May 2011
Line 122:		Line 122:
	<td>The class name in parentheses denotes a shared method and is one way to invoke <var>NewFromRecord</var>. You can also use an object expression whose type is <var>XmlDoc</var> (even if the value of the expression is null).</td></tr>		<td>The class name in parentheses denotes a shared method and is one way to invoke <var>NewFromRecord</var>. You can also use an object expression whose type is <var>XmlDoc</var> (even if the value of the expression is null).</td></tr>
	<tr><th>AllowNull</th>		<tr><th>AllowNull</th>
	<td>The value of this [[Boolean]] argument, which defaults to <var>False</var>, is copied to the <var>AllowNull</var> property of the <var>XmlDoc</var> created by <var>NewFromRecord</var>.		<td>The value of this [[Enumerations#Using Boolean enumerations\|Boolean]] argument, which defaults to <var>False</var>, is copied to the <var>AllowNull</var> property of the <var>XmlDoc</var> created by <var>NewFromRecord</var>.
	The <var>XmlDoc</var>'s <var>AllowNull</var> property, in turn, determines whether		The <var>XmlDoc</var>'s <var>AllowNull</var> property, in turn, determines whether
	field values that contain the X'00' character are stored in the		field values that contain the X'00' character are stored in the
Line 198:		Line 198:
	the <var class="product">Sirius Mods</var>, although the <var>AllowNull</var> argument was		the <var class="product">Sirius Mods</var>, although the <var>AllowNull</var> argument was
	not provided until version 7.7 of the <var class="product">Sirius Mods</var>.		not provided until version 7.7 of the <var class="product">Sirius Mods</var>.

	==LoadFromRecord subroutine in XmlDoc and XmlNode classes==		==LoadFromRecord subroutine in XmlDoc and XmlNode classes==
	This subroutine adds to an <var>XmlDoc</var> object a subtree that contains the fields and		This subroutine adds to an <var>XmlDoc</var> object a subtree that contains the fields and

Goff: /* XPathError exceptions */

2011-05-22T09:12:31Z

XPathError exceptions

← Older revision		Revision as of 09:12, 22 May 2011
Line 16:		Line 16:
	</nowiki></p>		</nowiki></p>
	Since the expression in the above invocation of the <var>Print</var> method		Since the expression in the above invocation of the <var>Print</var> method
	(<code>a b c</code>) is not a valid XPath expression, the above fragment		(<code>a b c</code>) is not a valid <var>[[XPath#XPath_syntax\|Xpath expression]]</var>, the above fragment
	will result in the following:		will result in the following:
	<p class="code"><nowiki>%err:Reason = SyntaxError		<p class="code"><nowiki>%err:Reason = SyntaxError
Line 55:		Line 55:
	<table>		<table>
	<tr><th>Reason		<tr><th>Reason
	</th><td>An enumeration of type <var>XmlPathErrorReason</var>. The possible values are: <table> <tr><th>SyntaxError </th><td>A violation of the syntax of an XPath expression. </td></tr> <tr><th>EmptyResult </th><td>There are no nodes matched by the XPath expression, and the method requires at least one matching node. </td></tr></table>		</th><td>An enumeration of type <var>XmlPathErrorReason</var>. The possible values are: <table> <tr><th>SyntaxError </th><td>A violation of the syntax of an <var>[[XPath#XPath_syntax\|Xpath expression]]</var>. </td></tr> <tr><th>EmptyResult </th><td>There are no nodes matched by the XPath expression, and the method requires at least one matching node. </td></tr></table>
	</td></tr>		</td></tr>
	<tr><th>CharacterPosition		<tr><th>CharacterPosition
Line 72:		Line 72:
	[[Methods#Named parameters\|NameRequired]], and have default values of the null string or 0 as appropriate.		[[Methods#Named parameters\|NameRequired]], and have default values of the null string or 0 as appropriate.
	</td></tr></table>		</td></tr></table>

	==NewFromRecord shared function in XmlDoc class==		==NewFromRecord shared function in XmlDoc class==
	This shared function creates a new <var>XmlDoc</var> object which contains the fields and		This shared function creates a new <var>XmlDoc</var> object which contains the fields and