BadJournal class - Revision history

Dme: /* Syntax */

2018-06-20T14:48:40Z

Syntax

← Older revision		Revision as of 14:48, 20 June 2018
Line 64:		Line 64:

	<tr><th><var>ReasonCode</var></th>		<tr><th><var>ReasonCode</var></th>
	<td>This ~~optional, but~~ [[Methods#Named parameters\|name required]] parameter ~~<var class="term>ReasonCode</var>,~~ specifies the numeric reason code to be assigned to the <var>BadJournal</var> exception object's <var>ReasonCode</var> property when a daemon thread is lost.		<td>This [[Methods#Named parameters\|name required]] parameter specifies the numeric reason code to be assigned to the <var>BadJournal</var> exception object's <var>ReasonCode</var> property when a daemon thread is lost.
	<p>		<p>
	The possible values are described below in [[ReasonCode (BadJournal property)#Syntax terms\|ReasonCode property]].</p>		The possible values are described below in [[ReasonCode (BadJournal property)#Syntax terms\|ReasonCode property]].</p>

JAL: link repair

2014-11-18T22:08:36Z

link repair

← Older revision		Revision as of 22:08, 18 November 2014
Line 32:		Line 32:
	0		0
	</p>		</p>
	<b>Note:</b> In order to display the reason code associated with the request, the exception is caught to a <var>BadJournal</var> object variable, against which the <var>[[ReasonCode_(BadJournal_property)\|ReasonCode]]</var> method runs.		<p class="note"><b>Note:</b> In order to display the reason code associated with the request, the exception is caught to a <var>BadJournal</var> object variable, against which the <var>[[ReasonCode_(BadJournal_property)\|ReasonCode]]</var> method runs. </p>

	The <var>BadJournal</var> class is available as of <var class="product">[[Sirius Mods]]</var> Version 7.8.		The <var>BadJournal</var> class is available as of <var class="product">[[Sirius Mods]]</var> Version 7.8.
Line 41:		Line 41:
	The methods in the class are described in the subsections that follow. In addition:		The methods in the class are described in the subsections that follow. In addition:
	<ul>		<ul>
	<li>[[Notation conventions for methods~~\|"Notation conventions for methods"~~]] has information		<li>[[Notation conventions for methods]] has information about the conventions followed. </li>
	about the conventions followed.		<li>[[BadJournal methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class. </li>
	<li>[[BadJournal methods syntax~~\|"BadJournal methods syntax"~~]] is a single page that contains the syntax diagrams of all the methods in the class.
	</ul>		</ul>

Line 56:		Line 55:

	====Syntax terms====		====Syntax terms====
	<table ~~class="syntaxTable"~~>		<table>
	<tr><th>%badJournal</th>		<tr><th>%badJournal</th>
	<td>A reference to an instance of a <var>[[BadJournal_class\|BadJournal]]</var> object.		<td>A reference to an instance of a <var>[[BadJournal_class\|BadJournal]]</var> object.
Line 62:		Line 61:

	<tr><th><var>[%(BadJournal):]</var></th>		<tr><th><var>[%(BadJournal):]</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 a <var>BadJournal</var> <var>Constructor</var>.</td></tr>		<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 a <var>BadJournal</var> <var>Constructor</var>.</td></tr>

	<tr><th><var>ReasonCode</var></th>		<tr><th><var>ReasonCode</var></th>
	<td>This optional, but [[Methods#Named parameters\|name required]] parameter <var class="term>ReasonCode</var>, specifies the numeric reason code to be assigned to the <var>BadJournal</var> exception object's <var>ReasonCode</var> property when a daemon thread is lost.		<td>This optional, but [[Methods#Named parameters\|name required]] parameter <var class="term>ReasonCode</var>, specifies the numeric reason code to be assigned to the <var>BadJournal</var> exception object's <var>ReasonCode</var> property when a daemon thread is lost.
	<p>The possible values are described below in [[ReasonCode (BadJournal property)#Syntax terms\|"ReasonCode property"]].</p>		<p>
			The possible values are described below in [[ReasonCode (BadJournal property)#Syntax terms\|ReasonCode property]].</p>
	</td></tr></table>		</td></tr></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">%badJournal = new		<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">%badJournal = new

	%badJournal = %(BadJournal):new		%badJournal = %(BadJournal):new

JAL at 21:32, 21 November 2012

2012-11-21T21:32:50Z

← Older revision		Revision as of 21:32, 21 November 2012
Line 5:		Line 5:
	An instance of the <var>BadJournal</var> exception class may be automatically thrown by the <var>[[New (Journal constructor)\|New]]</var> constructor of the <var>Journal</var> class; it is explicitly created with the <var>[[New (BadJournal constructor)\|New]]</var> constructor of the <var>BadJournal</var> class.</p>		An instance of the <var>BadJournal</var> exception class may be automatically thrown by the <var>[[New (Journal constructor)\|New]]</var> constructor of the <var>Journal</var> class; it is explicitly created with the <var>[[New (BadJournal constructor)\|New]]</var> constructor of the <var>BadJournal</var> class.</p>

	The following example shows a "[[Exceptions#Try and Catch\|Try and Catch]]" of a <var>Journal</var> class, <var>New</var> method, exception. An invalid journal name is specified to generate the <var>BadJournal</var> exception.		The following example shows a [[Exceptions#Try and Catch\|Try and Catch]] of a <var>Journal</var> class, <var>New</var> method, exception. An invalid journal name is specified to generate the <var>BadJournal</var> exception.

	<p class="code">begin		<p class="code">begin

JAL at 21:25, 21 November 2012

2012-11-21T21:25:57Z

New page

__NOTOC__
The <var>BadJournal</var> exception class reports errors in CCAJRNL or CCAJLOG datasets or streams, including naming errors, that are encountered by the <var>[[Journal class|Journal]]</var> class constructor.
<p>
An instance of the <var>BadJournal</var> exception class may be automatically thrown by the <var>[[New (Journal constructor)|New]]</var> constructor of the <var>Journal</var> class; it is explicitly created with the <var>[[New (BadJournal constructor)|New]]</var> constructor of the <var>BadJournal</var> class.</p>

The following example shows a "[[Exceptions#Try and Catch|Try and Catch]]" of a <var>Journal</var> class, <var>New</var> method, exception. An invalid journal name is specified to generate the <var>BadJournal</var> exception.

<p class="code">begin
%sl is object [[Stringlist class|stringlist]]
%rc is float
%journal is object journal
%bdjrnl is object badJournal

try [[PrintText statement|printText]] {~} is: {%journal = new('OLD~RNL')}
catch badJournal to %bdjrnl
print 'Failure!!! Reason code is: ' %bdjrnl:reasonCode
end try

%rc = %sl:appendJournalData( -
Options='MAXIO=1000 WIDTH=138 ST AA USER', -
Threads='*', Journal=%journal)
print %rc
print %sl:count
%sl:print
end
</p>
<p>
<var>[[AppendJournalData_(Stringlist_function)|AppendJournalData]]</var> does not cancel if its <var class="term>Journal</var> parameter is <var>null</var>. The request result shows the reason code stored in the exception object:</p>
<p class="output"> %journal = new('OLD~RNL') is: Failure!!! Reason code is: 1
0
0
</p>
<b>Note:</b> In order to display the reason code associated with the request, the exception is caught to a <var>BadJournal</var> object variable, against which the <var>[[ReasonCode_(BadJournal_property)|ReasonCode]]</var> method runs.

The <var>BadJournal</var> class is available as of <var class="product">[[Sirius Mods]]</var> Version 7.8.

==The BadJournal methods==
{{Template:List of BadJournal 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>[[BadJournal methods syntax|"BadJournal methods syntax"]] is a single page that contains the syntax diagrams of all the methods in the class.
</ul>

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

The <var>New</var> constructor generates an instance of a <var>[[BadJournal_class|BadJournal]]</var> exception object, optionally also setting the <var>[[ReasonCode (BadJournal property)|ReasonCode]]</var> property.

===Syntax===
{{Template:BadJournal:New syntax}}

====Syntax terms====
<table class="syntaxTable">
<tr><th>%badJournal</th>
<td>A reference to an instance of a <var>[[BadJournal_class|BadJournal]]</var> object.
</td></tr>

<tr><th><var>[%(BadJournal):]</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 a <var>BadJournal</var> <var>Constructor</var>.</td></tr>

<tr><th><var>ReasonCode</var></th>
<td>This optional, but [[Methods#Named parameters|name required]] parameter <var class="term>ReasonCode</var>, specifies the numeric reason code to be assigned to the <var>BadJournal</var> exception object's <var>ReasonCode</var> property when a daemon thread is lost.
<p>The possible values are described below in [[ReasonCode (BadJournal property)#Syntax terms|"ReasonCode property"]].</p>
</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">%badJournal = new

%badJournal = %(BadJournal):new

%badJournal = %badJournal:new
</p>
</ul>

==ReasonCode property==
{{Template:BadJournal:ReasonCode subtitle}}

===Syntax===
{{Template:BadJournal:ReasonCode syntax}}
====Syntax terms====
<table class="syntaxTable">
<tr><th>%number</th>
<td>This is a numeric variable to receive the code describing the reason the exception was thrown. Possible values include:
<table>
<tr><th><var>1</var></th><td>Either the dataset or stream name is invalid, or the journal is invalid.</td></tr>
<tr><th><var>2</var></th><td>The dataset or stream is empty.</td></tr>
<tr><th><var>3</var></th><td>The journal was created with a different <var class="product">Model 204</var> version than the current Online.</td></tr>
<tr><th><var>4</var></th><td>The content of the merged journal is invalid.</td></tr>
</table>
</td></tr>
<tr><th>badJournal</th>
<td>A reference to an instance of a <var>[[BadJournal_class|BadJournal]]</var> object.
</td></tr></table>

[[Category:System exception classes]]

JAL2 at 17:31, 7 August 2012

2012-08-07T17:31:41Z

← Older revision		Revision as of 17:31, 7 August 2012
Line 69:		Line 69:
	<h3>Usage notes</h3>		<h3>Usage notes</h3>
	<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">%~~maxdaem~~ = new		<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">%badJournal = new

	%badJournal = %(BadJournal):new		%badJournal = %(BadJournal):new

JAL2 at 17:28, 7 August 2012

2012-08-07T17:28:39Z

← Older revision		Revision as of 17:28, 7 August 2012
Line 52:		Line 52:
	<h3>Syntax</h3>		<h3>Syntax</h3>
	{{Template:BadJournal:New syntax}}		{{Template:BadJournal:New syntax}}

	<h4>Syntax terms</h4>		<h4>Syntax terms</h4>
	<table class="syntaxTable">		<table class="syntaxTable">
Line 57:		Line 58:
	<td>A reference to an instance of a <var>[[BadJournal_class\|BadJournal]]</var> object.		<td>A reference to an instance of a <var>[[BadJournal_class\|BadJournal]]</var> object.
	</td></tr>		</td></tr>
	<tr><th><var>%(BadJournal)</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>.</td></tr>
			<tr><th><var>[%(BadJournal):]</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 a <var>BadJournal</var> <var>Constructor</var>.</td></tr>

	<tr><th><var>ReasonCode</var></th>		<tr><th><var>ReasonCode</var></th>
	<td>This optional, but [[Methods#Named parameters\|name required]] parameter <var class="term>ReasonCode</var>, specifies the numeric reason code to be assigned to the <var>BadJournal</var> exception object's <var>ReasonCode</var> property when a daemon thread is lost.		<td>This optional, but [[Methods#Named parameters\|name required]] parameter <var class="term>ReasonCode</var>, specifies the numeric reason code to be assigned to the <var>BadJournal</var> exception object's <var>ReasonCode</var> property when a daemon thread is lost.
	<p>The possible values are described below in [[ReasonCode (BadJournal property)#Syntax terms\|"ReasonCode property"]].</p>		<p>The possible values are described below in [[ReasonCode (BadJournal property)#Syntax terms\|"ReasonCode property"]].</p>
	</td></tr></table>		</td></tr></table>

			<h3>Usage notes</h3>
			<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">%maxdaem = new

			%badJournal = %(BadJournal):new

			%badJournal = %badJournal:new
			</p>
			</ul>

JAL2 at 17:12, 7 August 2012

2012-08-07T17:12:56Z

← Older revision		Revision as of 17:12, 7 August 2012
Line 4:		Line 4:
	<p>An instance of the <var>BadJournal</var> exception class may be automatically thrown by the <var>[[New (Journal constructor)\|New]]</var> constructor of the <var>Journal</var> class; it is explicitly created with the <var>[[New (BadJournal constructor)\|New]]</var> constructor of the <var>BadJournal</var> class.</p>		<p>An instance of the <var>BadJournal</var> exception class may be automatically thrown by the <var>[[New (Journal constructor)\|New]]</var> constructor of the <var>Journal</var> class; it is explicitly created with the <var>[[New (BadJournal constructor)\|New]]</var> constructor of the <var>BadJournal</var> class.</p>

	The following example shows a "[[Try and Catch]]" of a <var>Journal</var> class, <var>New</var> method, exception. An invalid journal name is specified to generate the <var>BadJournal</var> exception~~. For more information about catching thrown exceptions, see "[[Try and Catch]]"~~.		The following example shows a "[[Exceptions#Try and Catch\|Try and Catch]]" of a <var>Journal</var> class, <var>New</var> method, exception. An invalid journal name is specified to generate the <var>BadJournal</var> exception.

	<p class="code">begin		<p class="code">begin
Line 12:		Line 12:
	%bdjrnl is object badJournal		%bdjrnl is object badJournal

	[[try]] [[PrintText statement\|printText]] {~} is: {%journal = new('OLD~RNL')}		try [[PrintText statement\|printText]] {~} is: {%journal = new('OLD~RNL')}
	[[catch]] badJournal to %bdjrnl		catch badJournal to %bdjrnl
	print 'Failure!!! Reason code is: ' %bdjrnl:reasonCode		print 'Failure!!! Reason code is: ' %bdjrnl:reasonCode
	end try		end try

JAL2 at 20:51, 27 July 2011

2011-07-27T20:51:56Z

← Older revision		Revision as of 20:51, 27 July 2011
Line 57:		Line 57:
	<td>A reference to an instance of a <var>[[BadJournal_class\|BadJournal]]</var> object.		<td>A reference to an instance of a <var>[[BadJournal_class\|BadJournal]]</var> object.
	</td></tr>		</td></tr>
	<tr><th><var>%(BadJournal)</var></th><td>The class name in parentheses denotes a ~~shared method~~.</td></tr>		<tr><th><var>%(BadJournal)</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>.</td></tr>
	<tr><th><var>ReasonCode</var></th>		<tr><th><var>ReasonCode</var></th>
	<td>This optional, but [[Methods#Named parameters\|name required]] parameter <var class="term>ReasonCode</var>, specifies the numeric reason code to be assigned to the <var>BadJournal</var> exception object's <var>ReasonCode</var> property when a daemon thread is lost.		<td>This optional, but [[Methods#Named parameters\|name required]] parameter <var class="term>ReasonCode</var>, specifies the numeric reason code to be assigned to the <var>BadJournal</var> exception object's <var>ReasonCode</var> property when a daemon thread is lost.

JAL2 at 22:03, 17 May 2011

2011-05-17T22:03:56Z

← Older revision		Revision as of 22:03, 17 May 2011
Line 50:		Line 50:
	The <var>New</var> constructor generates an instance of a <var>[[BadJournal_class\|BadJournal]]</var> exception object, optionally also setting the <var>[[ReasonCode (BadJournal property)\|ReasonCode]]</var> property.		The <var>New</var> constructor generates an instance of a <var>[[BadJournal_class\|BadJournal]]</var> exception object, optionally also setting the <var>[[ReasonCode (BadJournal property)\|ReasonCode]]</var> property.

	<h4>Syntax</h4>		<h3>Syntax</h3>
	{{Template:BadJournal:New syntax}}		{{Template:BadJournal:New syntax}}
	<h4>Syntax terms</h4>		<h4>Syntax terms</h4>
Line 60:		Line 60:
	<tr><th><var>ReasonCode</var></th>		<tr><th><var>ReasonCode</var></th>
	<td>This optional, but [[Methods#Named parameters\|name required]] parameter <var class="term>ReasonCode</var>, specifies the numeric reason code to be assigned to the <var>BadJournal</var> exception object's <var>ReasonCode</var> property when a daemon thread is lost.		<td>This optional, but [[Methods#Named parameters\|name required]] parameter <var class="term>ReasonCode</var>, specifies the numeric reason code to be assigned to the <var>BadJournal</var> exception object's <var>ReasonCode</var> property when a daemon thread is lost.
	<p>The possible values are described in [[ReasonCode (BadJournal property)#Syntax terms\|"ReasonCode property"]].</p>		<p>The possible values are described below in [[ReasonCode (BadJournal property)#Syntax terms\|"ReasonCode property"]].</p>
	</td></tr></table>		</td></tr></table>

Line 67:		Line 67:
	{{Template:BadJournal:ReasonCode subtitle}}		{{Template:BadJournal:ReasonCode subtitle}}

	<h4>Syntax</h4>		<h3>Syntax</h3>
	{{Template:BadJournal:ReasonCode syntax}}		{{Template:BadJournal:ReasonCode syntax}}
	<h4>Syntax terms</h4>		<h4>Syntax terms</h4>

JAL2 at 22:25, 9 May 2011

2011-05-09T22:25:37Z

← Older revision		Revision as of 22:25, 9 May 2011
Line 50:		Line 50:
	The <var>New</var> constructor generates an instance of a <var>[[BadJournal_class\|BadJournal]]</var> exception object, optionally also setting the <var>[[ReasonCode (BadJournal property)\|ReasonCode]]</var> property.		The <var>New</var> constructor generates an instance of a <var>[[BadJournal_class\|BadJournal]]</var> exception object, optionally also setting the <var>[[ReasonCode (BadJournal property)\|ReasonCode]]</var> property.

	==Syntax==		<h4>Syntax</h4>
	{{Template:BadJournal:New syntax}}		{{Template:BadJournal:New syntax}}
	~~===~~Syntax terms~~===~~		<h4>Syntax terms</h4>
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%badJournal</th>		<tr><th>%badJournal</th>
Line 67:		Line 67:
	{{Template:BadJournal:ReasonCode subtitle}}		{{Template:BadJournal:ReasonCode subtitle}}

	==Syntax==		<h4>Syntax</h4>
	{{Template:BadJournal:ReasonCode syntax}}		{{Template:BadJournal:ReasonCode syntax}}
	~~===~~Syntax terms~~===~~		<h4>Syntax terms</h4>
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%number</th>		<tr><th>%number</th>