View source for FindPreviousItem (GenericNamedArraylist function)

{{Template:GenericNamedArraylist:FindPreviousItem subtitle}}

This function searches "backward" in the NamedArraylist to find and return
the next item that matches a specified criterion.
The criterion is supplied by the [[SelectionCriterion class|SelectionCriterion]] object
that is a required FindPreviousItem parameter.
If no item satisfies the criterion,
the request is cancelled and an ItemNotFound exception ([[??]] refid=itemnfe.)
is thrown.

FindPreviousItem is available in ''Sirius Mods'' version 7.6 and later.
==Syntax==
{{Template:GenericNamedArraylist:FindPreviousItem syntax}}
===Syntax terms===
<dl>
<dt><i>%item</i>
<dd>A variable of the type of the items in the NamedArraylist to contain the
item that is located by the search.
<dt><i>%namrayl</i>
<dd>A NamedArraylist object.
<dt><i>criterion</i>
<dd>A SelectionCriterion object, which is a relational expression that is
applied to a ''%namrayl'' item value to determine
whether the value satisfies the expression.
The expression consists of a function, an operator, and a numeric or string value.

For example, <tt>LT(this, -11)</tt> is the
criterion <tt>this</tt> <tt><</tt> <tt>-11</tt>, where
<tt>this</tt> is an identity function that simply returns the item's value.
The first item tested by FindPreviousItem that satisfies this expression is
the method's return value.

The function in the criterion is
a method value (a method or class member name literal, or a method variable)
for a method
that operates on items of the type specified on the ''%namrayl''
declaration and that returns a numeric or string value.
This is described further in "[[SelectionCriterion class#Specifying a SelectionCriterion's parameters|Specifying a SelectionCriterion's parameters]]".
<dt><b>Start=</b><i> itemnum</i>
<dd>The number of the item ''before'' which to begin the search.
If the ''itemnum'' value of Start is 4, item 3 is the first item considered.
The value of Start may be 1 through one plus the number of items in
the NamedArraylist.
For a collection of three items, ''itemnum'' may be 1, 2, 3, or 4.

This is an optional argument, and it defaults to one plus the number of items in
the collection.
If you specify a value, the parameter name <tt>Start</tt> is required.

</dl>
==Usage notes==
<ul>
<li>If the value of Start is not in the range of 1 through one plus the number
of items in the NamedArraylist, the request is cancelled.
If the value of Start is 1, no item can be found and
the request is cancelled, but an ItemNotFound exception is thrown.
<li>The [[FindNextItem (NamedArraylist function)|FindNextItem]] function
is identical to FindPreviousItem except that it searches forward in the NamedArraylist.
</ul>
==Examples==

See [[FindPreviousItem (NamedArrayArraylist function)#Examples|NamedArrayArraylist FindPreviousItem function example]] for an example with a FindPreviousItem call.
==See also==
{{Template:GenericNamedArraylist:FindPreviousItem footer}}