<h3>System classes</h3>
<div class="mw-collapsible mw-collapsed" data-expandtext="▼" data-collapsetext="▲" style="float: left">
<table>
<tr><td style="border-right:0">CharacterMap class:</td><td style="border-left:0">[[CharacterMap class|Synopsis]] | [[List of CharacterMap methods|Methods]]</td></tr>

<tr><td style="border-right:0">CharacterToUnicodeMap class:</td><td style="border-left:0">[[CharacterToUnicodeMap class|Synopsis]] | [[List of CharacterToUnicodeMap methods|Methods]]</td></tr>

<tr><td style="border-right:0">[[Collections|Collection]] classes <ul class="nobul"><li>Arraylist class:<li>FloatNamedArraylist class:<li>NamedArraylist class:<li>UnicodeNamedArraylist class:</ul> </td>

<td style="border-left:0"> <ul class="nobulnoindent"><li>[[Arraylist class|Synopsis]] | [[List of Arraylist methods|Methods]]<li>[[FloatNamedArraylist class|Synopsis]] | [[List of FloatNamedArraylist methods|Methods]]<li>[[NamedArraylist class|Synopsis]] | [[List of NamedArraylist methods|Methods]]<li>[[UnicodeNamedArraylist class|Synopsis]] | [[List of UnicodeNamedArraylist methods|Methods]]</ul></td></tr>

<tr><td style="border-right:0">Daemon class:</td><td style="border-left:0">[[Daemon class|Synopsis]] | [[List of Daemon methods|Methods]]</td></tr>

<tr><td style="border-right:0">Dataset class:</td><td style="border-left:0">[[Dataset class|Synopsis]] | [[List of Dataset methods|Methods]]</td></tr>

<tr><td style="border-right:0">Email class:</td><td style="border-left:0">[[Email class|Synopsis]] | [[List of Email methods|Methods]]</td></tr>

<tr><td style="border-right:0">FastUnloadTask class:</td><td style="border-left:0">[[FastUnloadTask class|Synopsis]] | [[List of FastUnloadTask methods|Methods]]</td></tr>

<tr><td style="border-right:0">[[File classes]] <ul class="nobul"><li>Recordset class:<li>Record class:<li>SortedRecordset class:<li>RecordsetCursor class:</ul></td>
<td style="border-left:0"> <ul class="nobulnoindent"><li>[[Recordset class|Synopsis]] | [[List of Recordset methods|Methods]]<li>[[Record class|Synopsis]] | [[List of Record methods|Methods]]<li>[[SortedRecordset class|Synopsis]] | [[List of SortedRecordset methods|Methods]]<li>[[RecordsetCursor class|Synopsis]] | [[List of RecordsetCursor methods|Methods]]</ul></td></tr>

<tr><td style="border-right:0">[[HTTP Helper|HTTP Helper]] classes: <ul class="nobul"><li>HttpRequest class:<li>HttpResponse class:</ul></td>
<td style="border-left:0"> <ul class="nobulnoindent"><li>[[HttpRequest class|Synopsis]] | [[List of HttpRequest methods|Methods]]<li>[[HttpResponse class|Synopsis]] | [[List of HttpResponse methods|Methods]]</ul></td></tr>

<tr><td style="border-right:0">[[Intrinsic classes|Intrinsic]] classes: <ul class="nobul"><li>Float class:<li>String class:<li>Unicode class:</ul></td>
<td style="border-left:0"> <ul class="nobulnoindent"><li>[[List of Float methods|Methods]]<li>[[List of String methods|Methods]]<li>[[List of Unicode methods|Methods]]</ul></td></tr>

<tr><td style="border-right:0">Journal class:</td><td style="border-left:0">[[Journal class|Synopsis]] | [[List of Journal methods|Methods]]</td></tr>

<tr><td style="border-right:0">LDAP class:</td><td style="border-left:0">[[LDAP class|Synopsis]] | [[List of LDAP methods|Methods]]</td></tr>

<tr><td style="border-right:0">Object class:</td><td style="border-left:0">[[Global and session objects#Using Object class methods to access global and session objects|Synopsis]] | [[Global and session objects#Using Object class methods to access global and session objects|Methods]]</td></tr>

<tr><td style="border-right:0">PersistentObjectInfo class:</td><td style="border-left:0">[[PersistentObjectInfo class|Synopsis]] | [[List of PersistentObjectInfo methods|Methods]]</td></tr>

<tr><td style="border-right:0">ProcedureInfo class:</td><td style="border-left:0">[[ProcedureInfo class|Synopsis]] | [[List of ProcedureInfo methods|Methods]]</td></tr>

<tr><td style="border-right:0">RandomNumberGenerator class:</td><td style="border-left:0">[[RandomNumberGenerator class|Synopsis]] | [[List of RandomNumberGenerator methods|Methods]]</td></tr>

<tr><td style="border-right:0">Screen and ScreenField classes:</td>
<td style="border-left:0">[[Screen classes|Synopsis]] | [[List of Screen API methods|Methods]]</td></tr>

<tr><td style="border-right:0">SelectionCriterion class:</td><td style="border-left:0">[[SelectionCriterion class|Synopsis]] | [[List of SelectionCriterion methods|Methods]]</td></tr>

<tr><td style="border-right:0">Socket class:</td><td style="border-left:0">[[Socket class|Synopsis]] | [[List of Socket methods|Methods]]</td></tr>

<tr><td style="border-right:0">SortOrder class:</td><td style="border-left:0">[[SortOrder class|Synopsis]] | [[List of SortOrder methods|Methods]]</td></tr>

<tr><td style="border-right:0">Stringlist class:</td><td style="border-left:0">[[Stringlist class|Synopsis]] | [[List of Stringlist methods|Methods]]</td></tr>

<tr><td style="border-right:0">StringTokenizer class:</td><td style="border-left:0">[[StringTokenizer class|Synopsis]] | [[List of StringTokenizer methods|Methods]]</td></tr>

<tr><td style="border-right:0"><ul class="nobulnoindent"><li>System class:<li>Subsystem class:</ul></td>
<td style="border-left:0"><ul class="nobulnoindent"><li>[[System and Subsystem classes|Synopsis]] | [[List of System methods|Methods]]<li>[[System and Subsystem classes|Synopsis]] | [[List of Subsystem methods|Methods]]</ul></td></tr>

<tr><td style="border-right:0">UdpSocket class:</td><td style="border-left:0">[[UdpSocket class|Synopsis]] | [[List of UdpSocket methods|Methods]]</td></tr>

<tr><td style="border-right:0">UserStatistics class:</td><td style="border-left:0">[[UserStatistics class|Synopsis]] | [[List of UserStatistics methods|Methods]]</td></tr>

<tr><td style="border-right:0">[[XmlDoc API]] classes <ul class="nobul"><li>XmlDoc class:<li>XmlNode class:<li>XmlNodelist class:</ul> </td>
<td style="border-left:0">[[List of XmlDoc API methods|XmlDoc API methods]]<ul class="nobulnoindent"><li>[[XmlDoc API#The XmlDoc class|Synopsis]] | [[List of XmlDoc methods|XmlDoc methods]]<li>[[XmlDoc API#The XmlNode and XmlNodelist classes, and XPath|Synopsis]] | [[List of XmlNode methods|XmlNode methods]]<li>[[XmlDoc API#The XmlNode and XmlNodelist classes, and XPath|Synopsis]] | [[List of XmlNodelist methods|XmlNodelist methods]]</ul></td></tr>

<tr>
<td style="border-right:0">[[XmlParser API]] classes <ul class="nobul"><li>XmlParser class:<li>XmlSelector class:<li>XmlAttributeList class:</ul>XmlParser API types <ul class="nobul"><li>[[XmlStartHandler type]]<li>[[XmlEndHandler type]]<li>[[XmlPIHandler type]]</ul> </td>
<td style="border-left:0">[[List of XmlParser API methods|XmlParser API methods]]<ul class="nobulnoindent"><li>[[XmlParser class|Synopsis]] | [[List of XmlParser methods|XmlParser methods]]<li>[[XmlSelector class|Synopsis]] | [[List of XmlSelector methods|XmlSelector methods]]<li>[[XmlAttributeListClass|Synopsis]] | [[List of XmlAttributeList methods|XmlAttributeList methods]]</ul></td></tr>
</table>
</div>

<h3>Enumerations</h3>
<div class="mw-collapsible mw-collapsed" data-expandtext="▼" data-collapsetext="▲" style="float: left">
<table>
<tr><td colspan="2"><strong>[[Enumerations]]</strong>
<table class="noBorder"><tr><td style="border-right:0"><ul class="nobulnoindent">
<li>  [[ActionKey enumeration|ActionKey]]</li>
<li>  [[AddToRecordErrorReason enumeration|AddToRecordErrorReason]] </li>
<li>  [[Boolean enumeration|Boolean]]</li>
<li>  [[CursorState enumeration|CursorState]]</li>
<li>  [[DaemonState enumeration|DaemonState]]</li>
<li>  [[DatasetState enumeration|DatasetState]]</li>
<li>  [[FastUnloadTaskState enumeration|FastUnloadTaskState]]</li>
<li>  [[FieldColor enumeration|FieldColor]]</li>
<li>  [[Highlight enumeration|Highlight]]</li>
<li>  [[LineEnd enumeration|LineEnd]]</li>
<li>  [[LockStrength enumeration|LockStrength]]</li>
</ul></td>
<td style="border-left:0"><ul class="nobul">
<li>   [[RecordFormat enumeration|RecordFormat]]</li>
<li>   [[RecordLockType enumeration|RecordLockType]]</li>
<li>   [[RegexSplitOutputOptions enumeration|RegexSplitOutputOptions]]</li>
<li>   [[TranslationExceptionReason enumeration|TranslationExceptionReason]]</li>
<li>   [[XmlAdjacentTextSetting enumeration|XmlAdjacentTextSetting]]</li>
<li>   [[XmlInvalidChar enumeration|XmlInvalidChar]]</li>
<li>   [[XmlNamespaceSetting enumeration|XmlNamespaceSetting]]</li>
<li>   [[XmlNodeType enumeration|XmlNodeType]]</li>
<li>   [[XmlParseErrorReason enumeration|XmlParseErrorReason]]</li>
<li>   [[XPathErrorReason enumeration|XPathErrorReason]]</li>
</ul></td></tr></table></td></tr>
</table>
</div>

<h3>Exceptions</h3>
<div class="mw-collapsible mw-collapsed" data-expandtext="▼" data-collapsetext="▲" style="float: left">
<table>
<tr><td style="border-right:0"><div id="except"></div><strong>[[Exceptions|Exception]]</strong> classes<ul class="nobul">
<li>AddToRecordError: </li>
<li>BadJournal: </li>
<li>CharacterTranslationException: </li>
<li>DaemonLost: </li>
<li>IncorrectDaemonState: </li>
<li>InvalidBase64Data: </li>
<li>InvalidBitNumber: </li>
<li>InvalidDateString: </li>
<li>InvalidDeflateData: </li>
<li>InvalidGZipData: </li>
<li>InvalidHexData: </li>
<li>InvalidRegex: </li>
<li>InvalidSortSpecification: </li>
<li>InvalidValue: </li>
<li>ItemNotFound: </li>
<li>ItemNotPresent: </li>
<li>MaxDaemExceeded: </li>
<li>MismatchedQuote: </li>
<li>NoFreeDaemons: </li>
<li>NotJanusConnection: </li>
<li>OutOfBounds: </li>
<li>RecordLockingConflict: </li>
<li>ScreenReadError: </li>
<li>UnknownStatistic: </li>
<li>XmlParseError: </li>
<li>XPathError: </li></ul></td>

<td style="border-left:0"> <ul class="nobulnoindent">
<li>[[AddToRecordError class|Synopsis]] | [[AddToRecordError class#The AddToRecordError methods|Methods]]
<li>[[BadJournal class|Synopsis]] | [[BadJournal class#The BadJournal methods|Methods]]
<li>[[CharacterTranslationException class|Synopsis]] | [[CharacterTranslationException class#The CharacterTranslationException methods|Methods]]
<li>[[DaemonLost class|Synopsis]] | [[DaemonLost class#The DaemonLost methods|Methods]]
<li>[[IncorrectDaemonState class|Synopsis]] | [[IncorrectDaemonState class#The IncorrectDaemonState methods|Methods]]
<li>[[InvalidBase64Data class|Synopsis]] | [[InvalidBase64Data class#The InvalidBase64Data methods|Methods]]
<li>[[InvalidBitNumber class|Synopsis]] | [[InvalidBitNumber class#The InvalidBitNumber methods|Methods]]
<li>[[InvalidDateString class|Synopsis]] | [[InvalidDateString class#The InvalidDateString methods|Methods]]
<li>[[InvalidDeflateData class|Synopsis]] | [[InvalidDeflateData class#The InvalidDeflateData methods|Methods]]
<li>[[InvalidGZipData class|Synopsis]] | [[InvalidGZipData class#The InvalidGZipData methods|Methods]]
<li>[[InvalidHexData class|Synopsis]] | [[InvalidHexData class#The InvalidHexData methods|Methods]]
<li>[[InvalidRegex class|Synopsis]] | [[InvalidRegex class#The InvalidRegex methods|Methods]]
<li>[[InvalidSortSpecification class|Synopsis]] | [[InvalidSortSpecification class#The InvalidSortSpecification methods|Methods]]
<li>[[InvalidValue class|Synopsis]] | [[InvalidValue class#The InvalidValue methods|Methods]]
<li>[[ItemNotFound class|Synopsis]] | [[ItemNotFound class#The ItemNotFound methods|Methods]]
<li>[[ItemNotPresent class|Synopsis]] | [[ItemNotPresent class#The ItemNotPresent methods|Methods]]
<li>[[MaxDaemExceeded class|Synopsis]] | [[MaxDaemExceeded class#The MaxDaemExceeded methods|Methods]]
<li>[[MismatchedQuote class|Synopsis]] | [[MismatchedQuote class#The MismatchedQuote methods|Methods]]
<li>[[NoFreeDaemons class|Synopsis]] | [[NoFreeDaemons class#The NoFreeDaemons methods|Methods]]
<li>[[NotJanusConnection class|Synopsis]] | [[NotJanusConnection class#The NotJanusConnection methods|Methods]]
<li>[[OutOfBounds class|Synopsis]] | [[OutOfBounds class#The OutOfBounds methods|Methods]]
<li>[[RecordLockingConflict class|Synopsis]] | [[RecordLockingConflict class#The RecordLockingConflict methods|Methods]]
<li>[[ScreenReadError class|Synopsis]] | [[ScreenReadError class#The ScreenReadError methods|Methods]]
<li>[[UnknownStatistic class|Synopsis]] | [[UnknownStatistic class#The UnknownStatistic methods|Methods]]
<li>[[XmlParseError class|Synopsis]] | [[XmlParseError class#The XmlParseError methods|Methods]]
<li>[[XPathError class|Synopsis]] | [[XPathError class#The XPathError methods|Methods]]</ul></td></tr>
</table>
</div>

[[Category:Janus SOAP ULI topics]]

Lists of classes and methods

2013-05-03T21:58:54Z

JAL2:

Lists of classes and methods

2013-05-03T21:58:27Z

JAL2:

JAL2:

You can loop on the records in a Recordset or SortedRecordset object
using the traditional User Language FOR EACH RECORD loop construct, as
described in the preceding sections for those objects.
However, it can be
convenient to advance through a record set and access its records
outside the context of a single record loop.

The [[Janus SOAP]] RecordsetCursor object
gives you this additional capability for both Recordset and
SortedRecordset objects.
Essentially, a RecordsetCursor is a position
marker in a record set.
A cursor can be used to access the record at
its position, or the cursor can be moved to a new position.

==Cursor state==
A <var>RecordSetCursor</var> can be in various states as it navigates a record
set; these states are defined by the values of the <var>CursorState</var> [[Enumerations|enumeration]]:
<dl>
<dt>BeforeStart
<dd>The cursor is positioned before the first record in
the set.
<dt>HasRecord
<dd>The cursor points to a record that is available for
processing.
<dt>AfterEnd
<dd>The cursor is positioned after the last record in
the set.
<dt>NoRecord
<dd>The cursor ''had'' a
valid position identifying a record in a record set, but a subsequent operation
(A <var>Recordset</var> <var>[[Clear (Recordset subroutine)|Clear]]</var> or <var>[[RemoveRecord (Recordset subroutine)|RemoveRecord]]</var> method) removed the
record from the underlying <var>Recordset</var>.
This state is new in <var class="product">Sirius Mods</var> version 7.0.
<dt>Empty
<dd>The cursor points to an empty record set.
This state is new in <var class="product">Sirius Mods</var> version 7.6.
</dl>

The CursorState enumeration returns the state of a cursor:
<p class="code"> %state is enumeration CursorState
</p>

'''Note:''' As with all enumerations, the <var>ToString</var> method implicitly converts an enumeration value to a character string whose value is the name of the enumeration value. For more information about methods available to all enumerations, see [[Enumerations#Common enumeration methods|"Common enumeration methods"]].

The <var>RecordsetCursor</var> read-only property <var>[[State (RecordsetCursor function)|State]]</var> returns a <var>CursorState</var> enumeration that indicates the current state of the cursor.

Any method that repositions the cursor returns
a <var>CursorState</var> enumeration that indicates the new state of the cursor
after the completion of the operation performed by the method.

==Declaration and instantiation==
A RecordsetCursor is declared like any other file or group context
based object.
For example:
<p class="code"> %myCurs1 is object RecordsetCursor in file ftptest

%myCurs2 is object RecordsetCursor in group foo
</p>

Prior to version 7.6 of the <var class="product">Sirius Mods</var>, the RecordsetCursor class
contained no native constructor methods, and
the way to instantiate a RecordsetCursor object is to use
the Cursor method provided by
both the Recordset and SortedRecordset classes.
In version 7.6, the RecordsetCursor New method was added,
primarily to enable the creation of extension classes of
the RecordsetCursor class, which the Cursor constructor
cannot do.

Instantiation by the Cursor and New methods is described below.
<ul>
<li>The Cursor method instantiates a RecordsetCursor for a
particular instance of a Recordset or SortedRecordset object.
The method takes no arguments.
If the set has at least
one record, Cursor instantiates an instance of the RecordsetCursor object.
If Cursor is called on a set that “isEmpty” (0 records), it
returns a Null object.

Here is a small syntax example:
<p class="code"> %rs is object recordSet in file stooges
%srs is object SortedRecordset in file stooges
%myCursor1 is object RecordsetCursor in file stooges
%myCursor2 is object RecordsetCursor in file stooges
...
fd to %rs
end find
...
sort records in %rs to %srs by name
...
%myCursor1 = %rs:Cursor
%myCursor2 = %srs:Cursor
</p>
<li>Since a RecordsetCursor references a Recordset or SortedRecordset object
and may have a LoopLockStrength, the RecordsetCursor <code>New</code>
constructor is of this form:
==Unknown title==
<p class="pre"> %(RecordsetCursor):New(<recset> [,loopLockStrength=<lls>])
</p>

Where:
<dl>
<dt><recset>
<dd>A required Recordset or SortedRecordset object.
<dt><lls>
<dd>A LockStrength enumeration setting the minimum lock strength for a record
in a For Record At loop on a RecordsetCursor object.
This argument is only valid if <code><recset></code> is a
SortedRecordset object.
</dl>
'''Note:'''
If <code><recset></code> is empty, New returns a RecordsetCursor
object with the state <code>Empty</code>.
This is different from the Cursor methods instantiation,
which return a null if <code><recset></code> is empty.
</ul>

With either of the instantiation methods,
when a RecordsetCursor is instantiated, it is automatically
positioned on the first record in the set (state=HasRecord).

You can have as many cursors as you want for a record set.
==Referencing a RecordsetCursor object==
If the [[State (RecordsetCursor property)|state]] of a RecordsetCursor is HasRecord, it can be
referenced on a new FOR/END FOR variation:
<p class="code"> FOR RECORD AT CURSOR %RecordsetCursorObject
... whatever
END FOR
</p>

If the cursor is not in HasRecord state, the request is cancelled.

Processing a record with this construct is very much like processing
it with a FOR EACH RECORD loop that runs on a set that only contains
that record.
This means:
<ul>
<li>No extra record locking is done.
The record is locked (or not) at
whatever level the underlying record set is.
<li>If the cursor is for a SortedRecordset that was created using a
SORT RECORDS TO statement, the records returned will be copies
of the actual records.
If the SortedRecordset was created with
SORT RECORD KEYS, the actual Table B record from the file is
returned.
This is consistent with the contrasting behaviour of SORT RECORDS and
SORT RECORD KEYS elsewhere in <var class="product">Model 204</var>.
</ul>

The <code>FOR RECORD %recobj</code> construct can be used on the
result of the
RecordsetCursor CurrentRecord method (or on a record object
to which the method result was assigned).
For example:
<p class="code"> FOR RECORD %myCursor1:CurrentRecord
... whatever
END FOR
</p>

Or, for example:
<p class="code"> %r is object record in foo
%r = %myCursor1:CurrentRecord(exclusive)
FOR RECORD %r
... whatever
END FOR
</p>
This second technique is less efficient, because you incur the
overhead of record Object instantiation and record locking.
It is more
flexible because you can control the locking strength.

In addition, with this technique you always refer to the real record in Table
B, and never to a Sort copy.
===LoopLockStrength for RecordsetCursors===
In addition to the LockStrength property, in <var class="product">Sirius Mods</var> 7.0 and later,
all RecordsetCursor objects also have a LoopLockStrength property.
Like the LockStrength property, the LoopLockStrength property's values
are of the LockStrength enumeration.
The LoopLockStrength property indicates the minimum lock strength for
the record being processed in an iteration of a For Record At loop
on a RecordsetCursor object.

If the LoopLockStrength is the same as or weaker than the LockStrength
of a RecordsetCursor object (which is, in fact, the lock strength of
the underlying Recordset object),
no action is required at the start of each loop
— the record in the iteration is known to be locked at the
strength of the Recordset which is greater than the LoopLockStrength.
If, however, the LoopLockStrength is stronger than the LockStrength,
each execution of a For Record At loop on a RecordsetCursor object tries
to obtain a LoopLockStrength level lock on the record in the iteration.
If successful, the iteration is processed and the lock is released
at the end of the loop execution.

The default value of LoopLockStrength is <code>None</code>, which means that
no additional locking is performed for the record in the RecordsetCursor
during loop processing.

LoopLockStrength locking behavior is identical to the locking
behavior of the For Record Number (FRN) statement.
The meanings of certain statements in an On Record Locking conflict
unit are identical to their meaning for a For Record Number statement
conflict:
<dl>
<dt>Bypass
<dd>Causes processing of the record to be skipped, which means that
the For Record loop is not processed.
<dt>Retry
<dd>Causes the For Record At statement to be re-executed and
to try again to lock the record at the LoopLockStrength level.
</dl>

There are many similarities in LoopLockStrength processing for
RecordsetCursor and <var>Recordset</var> objects.
For more information about the use of LoopLockStrength with Recordset
objects see [[Recordset class#LoopLockStrength for Recordsets|"LoopLockStrength for Recordsets"]].
==Discarding a cursor==
In addition to the standard discard (<code>%myCursor1:Discard</code>),
you can also use the Close method to discard a RecordsetCursor object:
<p class="code"> %myCursor1:close
</p>

==List of RecordsetCursor methods==
The [[List of RecordsetCursor methods|"List of RecordsetCursor methods"]] shows all the class methods.

[[Category:System classes]]