BadJournal class: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
<!-- BadJournal class --> | <!-- BadJournal class --> | ||
__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]]</var> constructor. | 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]]</var> 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> | <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> | ||
| Line 34: | Line 35: | ||
<h2>The BadJournal methods</h2> | <h2>The BadJournal methods</h2> | ||
{{Template:List of BadJournal methods}} | {{Template:List of BadJournal methods}} | ||
| Line 44: | Line 44: | ||
</ul> | </ul> | ||
<h2>New constructor</h2> | |||
{{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</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>%(BadJournal)</th><td>The class name in parentheses denotes a shared method.</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 in "[[ReasonCode (BadJournal property)#Syntax terms|BadJournal ReasonCodes]]".</p> | |||
</td></tr></table> | |||
<h2>ReasonCode property</h2> | |||
[[Category:System exception classes]] | [[Category:System exception classes]] | ||
Revision as of 21:26, 9 May 2011
The BadJournal exception class reports errors in CCAJRNL or CCAJLOG datasets or streams, including naming errors, that are encountered by the Journal class constructor.
An instance of the BadJournal exception class may be automatically thrown by the New constructor of the Journal class; it is explicitly created with the New constructor of the BadJournal class.
The following example shows a "Try and Catch" of a Journal class, New method, exception. An invalid journal name is specified to generate the BadJournal exception. For more information about catching thrown exceptions, see "Try and Catch".
begin %sl is object stringlist %rc is float %journal is object journal %bdjrnl is object badJournal try 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
AppendJournalData does not cancel if its Journal parameter is null. The request result shows the reason code stored in the exception object:
%journal = new('OLD~RNL') is: Failure!!! Reason code is: 1 0 0
Note: In order to display the reason code associated with the request, the exception is caught to a BadJournal object variable, against which the ReasonCode method runs.
The BadJournal class is available as of Sirius Mods Version 7.8.
The BadJournal methods
The following are the available BadJournal class methods.
| Method | Description |
|---|---|
| New | Create a new BadJournal object |
| ReasonCode | Numeric code indicating cause of BadJournal exception |
The methods in the class are described in the subsections that follow. In addition:
- "Notation conventions for methods" has information about the conventions followed.
- "BadJournal methods syntax" is a single page that contains the syntax diagrams of all the methods in the class.
New constructor
Create a new BadJournal object (BadJournal class)
[Introduced in Sirius Mods 7.8]
The New constructor generates an instance of a BadJournal exception object, optionally also setting the ReasonCode property.
Syntax
%badJournal = [%(BadJournal):]New( ReasonCode= number)
Syntax terms
| %badJournal | A reference to an instance of a BadJournal object. |
|---|---|
| %(BadJournal) | The class name in parentheses denotes a shared method. |
| ReasonCode | This optional, but name required parameter ReasonCode, specifies the numeric reason code to be assigned to the BadJournal exception object's ReasonCode property when a daemon thread is lost.
The possible values are described in "BadJournal ReasonCodes". |