.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "DBIx::SearchBuilder::Union 3pm"
.TH DBIx::SearchBuilder::Union 3pm 2024-01-27 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
DBIx::SearchBuilder::Union \- Deal with multiple SearchBuilder result sets as one
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\&  use DBIx::SearchBuilder::Union;
\&  my $U = new DBIx::SearchBuilder::Union;
\&  $U\->add( $tickets1 );
\&  $U\->add( $tickets2 );
\&
\&  $U\->GotoFirstItem;
\&  while (my $z = $U\->Next) {
\&    printf "%5d %30.30s\en", $z\->Id, $z\->Subject;
\&  }
.Ve
.SH WARNING
.IX Header "WARNING"
This module is still experimental.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Implements a subset of the DBIx::SearchBuilder collection methods, but
enough to do iteration over a bunch of results.  Useful for displaying
the results of two unrelated searches (for the same kind of objects)
in a single list.
.SH METHODS
.IX Header "METHODS"
.SS new
.IX Subsection "new"
Create a new DBIx::SearchBuilder::Union object.  No arguments.
.ie n .SS "add $sb"
.el .SS "add \f(CW$sb\fP"
.IX Subsection "add $sb"
Add a searchbuilder result (collection) to the Union object.
.PP
It must be the same type as the first object added.
.SS First
.IX Subsection "First"
Return the very first element of the Union (which is the first element
of the first Collection).  Also reset the current pointer to that
element.
.SS Next
.IX Subsection "Next"
Return the next element in the Union.
.SS Last
.IX Subsection "Last"
Returns the last item
.SS Count
.IX Subsection "Count"
Returns the total number of elements in the Union'ed Collection
.SS GotoFirstItem
.IX Subsection "GotoFirstItem"
Starts the recordset counter over from the first item. the next time
you call Next, you'll get the first item returned by the database, as
if you'd just started iterating through the result set.
.SS IsLast
.IX Subsection "IsLast"
Returns true if the current row is the last record in the set.
.SS ItemsArrayRef
.IX Subsection "ItemsArrayRef"
Return a reference to an array containing all objects found by this search.
.PP
Will destroy any positional state.