.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "Bio::Tools::EUtilities::History 3pm"
.TH Bio::Tools::EUtilities::History 3pm "2020-03-13" "perl v5.30.0" "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"
Bio::Tools::EUtilities::History \- Lightweight implementation of HistoryI interface (not bound to filehandles, extraneous methods, etc).
.SH "VERSION"
.IX Header "VERSION"
version 1.77
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  #should work for any class which is\-a HistoryI
\&
\&  if ($obj\->has_History) {
\&      # do something here
\&  }
\&
\&  ($webenv, $querykey) = $obj\->history;
\&
\&  $obj\->history($webenv, $querykey);
\&
\&  $webenv = $obj\->get_webenv;
\&
\&  $query_key = $obj\->get_query_key;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class extends methods for any EUtilDataI implementation allow instances to
dealwith \s-1NCBI\s0 history data (WebEnv and query_key).  These can be used as
parameters for further queries against data sets stored on the \s-1NCBI\s0 server, much
like \s-1NCBI\s0's Entrez search history. These are important when one wants to run
complex queries using esearch, retrieve related data using elink, and retrieve
large datasets using epost/efetch.
.PP
This class is the simplest implementation and merely holds data for future
queries from any HistoryI. See also Bio::Tools::EUtilities::Query (esearch) and
Bio::Tools::EUtilities::LinkSet (elink), which also implement HistoryI.
.SS "history"
.IX Subsection "history"
.Vb 5
\& Title    : history
\& Usage    : my ($webenv, $qk) = $hist\->history
\& Function : Get/Set two\-element list of webenv() and query_key()
\& Returns  : array
\& Args     : two\-element list of webenv, query key
.Ve
.SS "get_webenv"
.IX Subsection "get_webenv"
.Vb 6
\& Title    : get_webenv
\& Usage    : my $webenv = $hist\->get_webenv
\& Function : returns web environment key needed to retrieve results from
\&            NCBI server
\& Returns  : string (encoded key)
\& Args     : none
.Ve
.SS "get_query_key"
.IX Subsection "get_query_key"
.Vb 5
\& Title    : get_query_key
\& Usage    : my $qk = $hist\->get_query_key
\& Function : returns query key (integer) for the history number for this session
\& Returns  : integer
\& Args     : none
.Ve
.SS "to_string"
.IX Subsection "to_string"
.Vb 6
\& Title    : to_string
\& Usage    : $foo\->to_string()
\& Function : converts current object to string
\& Returns  : none
\& Args     : (optional) simple data for text formatting
\& Note     : Used generally for debugging and for the print_* methods
.Ve
.SH "FEEDBACK"
.IX Header "FEEDBACK"
.SS "Mailing lists"
.IX Subsection "Mailing lists"
User feedback is an integral part of the evolution of this and other
Bioperl modules. Send your comments and suggestions preferably to
the Bioperl mailing list.  Your participation is much appreciated.
.PP
.Vb 2
\&  bioperl\-l@bioperl.org               \- General discussion
\&  https://bioperl.org/Support.html    \- About the mailing lists
.Ve
.SS "Support"
.IX Subsection "Support"
Please direct usage questions or support issues to the mailing list:
\&\fIbioperl\-l@bioperl.org\fR
rather than to the module maintainer directly. Many experienced and
reponsive experts will be able look at the problem and quickly
address it. Please include a thorough description of the problem
with code and data examples if at all possible.
.SS "Reporting bugs"
.IX Subsection "Reporting bugs"
Report bugs to the Bioperl bug tracking system to help us keep track
of the bugs and their resolution. Bug reports can be submitted via the
web:
.PP
.Vb 1
\&  https://github.com/bioperl/bio\-eutilities/issues
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Chris Fields <cjfields@bioperl.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
This software is copyright (c) 2006\-2013 by Chris Fields.
.PP
This software is available under the same terms as the perl 5 programming language system itself.