InvalidJsonType class - Revision history

ELowell at 16:12, 23 August 2016

2016-08-23T16:12:46Z

← Older revision		Revision as of 16:12, 23 August 2016
Line 8:		Line 8:
	Remember that you catch an exception with the <var>[[Exceptions#Try and Catch\|Catch]]</var> statement; if an exception condition occurs outside a <var>Catch</var> for it, the request is cancelled.		Remember that you catch an exception with the <var>[[Exceptions#Try and Catch\|Catch]]</var> statement; if an exception condition occurs outside a <var>Catch</var> for it, the request is cancelled.

	The <var>InvalidJsonType</var> class, like the Json class is available as of <var class="product">Model 204</var> 7.6.		The <var>InvalidJsonType</var> class, like the Json class, is available as of <var class="product">Model 204</var> 7.6.

	==The InvalidJsonTypes methods==		==The InvalidJsonTypes methods==

Alex: /* New constructor */

2015-02-18T20:46:34Z

New constructor

← Older revision		Revision as of 20:46, 18 February 2015
Line 56:		Line 56:
	{{Template:InvalidJsonType:New subtitle}}		{{Template:InvalidJsonType:New subtitle}}

	This <var>Constructor</var> generates an instance of an <var>[[~~InvalidGZipData_class~~\|~~InvalidGZipData~~]]</var> exception. The <var>New</var> method format follows:		This <var>Constructor</var> generates an instance of an <var>[[InvalidJsonType_class\|InvalidJsonType]]</var> exception. The <var>New</var> method format follows:
	===Syntax===		===Syntax===
	{{Template:InvalidJsonType:New syntax}}		{{Template:InvalidJsonType:New syntax}}

Alex at 20:36, 18 February 2015

2015-02-18T20:36:41Z

← Older revision		Revision as of 20:36, 18 February 2015
Line 2:		Line 2:
	[[Json class\|Json]] objects simulate JavaScript untyped variables. However, many Json functions only make sense for specific underlying Json data. For example, the [[Add (Json function)\|Add function]] only makes sense if the underlying json object is an Array. If a function applied to a Json object is invalid for the underlying object, an <var>InvalidJsonType</var> exception is thrown.		[[Json class\|Json]] objects simulate JavaScript untyped variables. However, many Json functions only make sense for specific underlying Json data. For example, the [[Add (Json function)\|Add function]] only makes sense if the underlying json object is an Array. If a function applied to a Json object is invalid for the underlying object, an <var>InvalidJsonType</var> exception is thrown.

	To create an <var>InvalidjsonType</var> exception yourself, you typically use a SOUL <var>[[Exceptions#Using the Throw statement\|Throw]]</var> statement with an <var>~~InvalidJsonTyoe~~</var> <var>[[New_(InvalidJsonType_constructor)\|New]]</var> constructor. This statement must be issued from within a method, and it can only be caught by the code that calls the method. For example, the following statement throws an <var>InvalidJsonType</var> exception:		To create an <var>InvalidjsonType</var> exception yourself, you typically use a SOUL <var>[[Exceptions#Using the Throw statement\|Throw]]</var> statement with an <var>InvalidJsonType</var> <var>[[New_(InvalidJsonType_constructor)\|New]]</var> constructor. This statement must be issued from within a method, and it can only be caught by the code that calls the method. For example, the following statement throws an <var>InvalidJsonType</var> exception:
	<p class="code">throw %(invalidJsonType):new(type=array, method="MyJsonMethod")		<p class="code">throw %(invalidJsonType):new(type=array, method="MyJsonMethod")
	</p>		</p>

Alex: /* Type property */

2015-02-17T20:20:42Z

Type property

@@ Line 19: / Line 19: @@
 <li>[[InvalidJsonType methods syntax|"InvalidJsonType methods syntax"]] is a single page that contains the syntax diagrams of all the methods in the class.
 </ul>
 ==Type property==
 {{Template:InvalidJsonType:Type subtitle}}

Alex: /* The InvalidJsonTypes methods */

2015-02-17T20:15:56Z

The InvalidJsonTypes methods

@@ Line 19: / Line 19: @@
 <li>[[InvalidJsonType methods syntax|"InvalidJsonType methods syntax"]] is a single page that contains the syntax diagrams of all the methods in the class.
 </ul>
 ==New constructor==
 {{Template:InvalidJsonType:New subtitle}}

Alex: /* Syntax terms */

2015-02-17T19:52:21Z

Syntax terms

← Older revision		Revision as of 19:52, 17 February 2015
Line 30:		Line 30:
	====Syntax terms====		====Syntax terms====
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%invalidJsonType</th>		<tr><th>%invalidJsonType</th><td>A reference to an instance of an <var>InvalidJsonType</var> object.</td></tr>
	<td>A reference to an instance of an <var>InvalidJsonType</var> object. </td></tr>		<tr><th><var>[%(InvalidJsonType):]</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>.</td></tr>
	<tr><th><var>[%(InvalidJsonType):]</var></th>
	<td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]~~</var>.~~</var>.</td></tr>
	<tr><th>jsonType</th><td>A [[JsonType enumeration]] value that indicates the underlying JSON type of the object to which the invalid method was applied.</td></tr>		<tr><th>jsonType</th><td>A [[JsonType enumeration]] value that indicates the underlying JSON type of the object to which the invalid method was applied.</td></tr>
	<tr><th>string</th><td>The name of the method that encountered the error.</td></tr>		<tr><th>string</th><td>The name of the method that encountered the error.</td></tr>
	</table>		</table>

	===Usage notes===		===Usage notes===
	<ul>		<ul>

Alex: /* New constructor */

2015-02-17T19:49:38Z

New constructor

← Older revision		Revision as of 19:49, 17 February 2015
Line 32:		Line 32:
	<tr><th>%invalidJsonType</th>		<tr><th>%invalidJsonType</th>
	<td>A reference to an instance of an <var>InvalidJsonType</var> object. </td></tr>		<td>A reference to an instance of an <var>InvalidJsonType</var> object. </td></tr>
	<tr><th><var>[%(~~InvalidGZipData~~):]</var></th>		<tr><th><var>[%(InvalidJsonType):]</var></th>
	<td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. ~~See~~ [[~~#Usage notes\|"Usage notes"~~]]~~, below, for more information about invoking an~~ <~~var~~>~~InvalidGZipData~~</~~var~~> <~~var~~>~~Constructor~~</~~var~~>.</td></tr>		<td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>.</var>.</td></tr>
			<tr><th>jsonType</th><td>A [[JsonType enumeration]] value that indicates the underlying JSON type of the object to which the invalid method was applied.</td></tr>
			<tr><th>string</th><td>The name of the method that encountered the error.</td></tr>
	</table>		</table>

	===Usage notes===		===Usage notes===
	<ul>		<ul>
	<li>~~As described in~~ [[~~Object variables#Using New or other Constructors~~\|~~"Using New or other Constructors"~~]], ~~<var>New</var> can~~ be ~~invoked with no~~ object, with ~~an explicit class~~ name, ~~or with an object variable in~~ the ~~class~~, ~~even if that object is <var>Null</var>~~:<p class="code">%~~invalid~~ = ~~new~~		<li>Json object tree can be created from data received from an outside data source that was generated via the [[Parse (Json function)\|Json Parse]] function. If the external data source is considered 100% in terms of sending JSON data with a known format, the data could be extracted without worries about InvalidJsonType exceptions. However, if there is a concern that the data will not be exactly what is expected, one should either test each object for the expected datatype via the [[Type (Json function)\|Type function]] or wrap the data extraction inside a Try/Catch InvalidJsonType. Obviously, the latter requires less effort and is more efficient. For example, if an application expects an order to come in as an array of objects with a product name, code, quantity, and price but the source is not 100% trustworthy, one can do something like:
			<p class="code">try
	%~~invalid~~ = %(~~InvalidGZipData~~):~~new~~		for %i from 1 to %order:count
			%name = %order(%i)("name"):stringValue
	%~~invalid~~ = %~~invalid~~:~~new~~		%code = %order(%i)("code"):stringValue
			%quantity = %order(%i)("quantity"):numberValue
			%price = %order(%i)("price"):numberValue
			... process the order item
			end for
			catch invalidJsonType
			... deal with the error
			end try
	</p>		</p>
			The Try/Catch adds no overhead to the processing but makes it easy to trap a malformed request.
	</ul>		</ul>
	[[Category:System exception classes]]		[[Category:System exception classes]]

Alex: Created page with " Json objects simulate JavaScript untyped variables. However, many Json functions only make sense for specific underlying Json dat..."

2015-02-17T19:28:39Z

Created page with " Json objects simulate JavaScript untyped variables. However, many Json functions only make sense for specific underlying Json dat..."

New page

[[Json class|Json]] objects simulate JavaScript untyped variables. However, many Json functions only make sense for specific underlying Json data. For example, the [[Add (Json function)|Add function]] only makes sense if the underlying json object is an Array. If a function applied to a Json object is invalid for the underlying object, an <var>InvalidJsonType</var> exception is thrown.

To create an <var>InvalidjsonType</var> exception yourself, you typically use a SOUL <var>[[Exceptions#Using the Throw statement|Throw]]</var> statement with an <var>InvalidJsonTyoe</var> <var>[[New_(InvalidJsonType_constructor)|New]]</var> constructor. This statement must be issued from within a method, and it can only be caught by the code that calls the method. For example, the following statement throws an <var>InvalidJsonType</var> exception:
<p class="code">throw %(invalidJsonType):new(type=array, method="MyJsonMethod")
</p>

Remember that you catch an exception with the <var>[[Exceptions#Try and Catch|Catch]]</var> statement; if an exception condition occurs outside a <var>Catch</var> for it, the request is cancelled.

The <var>InvalidJsonType</var> class, like the Json class is available as of <var class="product">Model 204</var> 7.6.

==The InvalidJsonTypes methods==
{{Template:List of InvalidJsonType methods}}

The methods in the class are described in the subsections that follow. In addition:
<ul>
<li>[[Notation conventions for methods|"Notation conventions for methods"]] has information
about the conventions followed.
<li>[[InvalidJsonType methods syntax|"InvalidJsonType methods syntax"]] is a single page that contains the syntax diagrams of all the methods in the class.
</ul>

==New constructor==
{{Template:InvalidJsonType:New subtitle}}

This <var>Constructor</var> generates an instance of an <var>[[InvalidGZipData_class|InvalidGZipData]]</var> exception. The <var>New</var> method format follows:
===Syntax===
{{Template:InvalidJsonType:New syntax}}

====Syntax terms====
<table class="syntaxTable">
<tr><th>%invalidJsonType</th>
<td>A reference to an instance of an <var>InvalidJsonType</var> object. </td></tr>
<tr><th><var>[%(InvalidGZipData):]</var></th>
<td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes|"Usage notes"]], below, for more information about invoking an <var>InvalidGZipData</var> <var>Constructor</var>.</td></tr>
</table>

===Usage notes===
<ul>
<li>As described in [[Object variables#Using New or other Constructors|"Using New or other Constructors"]], <var>New</var> can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is <var>Null</var>:<p class="code">%invalid = new

%invalid = %(InvalidGZipData):new

%invalid = %invalid:new
</p>
</ul>
[[Category:System exception classes]]