Migrate to S4 Classes
Change-Id: I27e9452e9d59f6b414898390074908ec0e91e2a9
diff --git a/man/KorAPQuery-class.Rd b/man/KorAPQuery-class.Rd
new file mode 100644
index 0000000..68d8907
--- /dev/null
+++ b/man/KorAPQuery-class.Rd
@@ -0,0 +1,90 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/KorAPQuery.R
+\docType{class}
+\name{KorAPQuery-class}
+\alias{KorAPQuery-class}
+\alias{KorAPQuery}
+\alias{initialize,KorAPQuery-method}
+\alias{fetchNext,KorAPQuery-method}
+\alias{fetchNext}
+\alias{fetchAll,KorAPQuery-method}
+\alias{fetchAll}
+\alias{fetchRest,KorAPQuery-method}
+\alias{fetchRest}
+\alias{format.KorAPQuery}
+\alias{show,KorAPQuery-method}
+\title{Class KorAPQuery}
+\usage{
+\S4method{initialize}{KorAPQuery}(.Object, request = NULL, vc = "",
+ totalResults = 0, nextStartIndex = 0, fields = c("corpusSigle",
+ "textSigle", "pubDate", "pubPlace", "availability", "textClass",
+ "snippet"), requestUrl = "", webUIRequestUrl = "",
+ apiResponse = NULL, hasMoreMatches = FALSE,
+ collectedMatches = NULL)
+
+\S4method{fetchNext}{KorAPQuery}(kqo, offset = kqo@nextStartIndex,
+ maxFetch = maxResultsPerPage, verbose = FALSE)
+
+\S4method{fetchAll}{KorAPQuery}(kqo, verbose = FALSE)
+
+\S4method{fetchRest}{KorAPQuery}(kqo, verbose = FALSE)
+
+\method{format}{KorAPQuery}(x, ...)
+
+\S4method{show}{KorAPQuery}(object)
+}
+\arguments{
+\item{.Object}{…}
+
+\item{request}{query part of the request URL}
+
+\item{vc}{definition of a virtual corpus}
+
+\item{totalResults}{number of hits the query has yielded}
+
+\item{nextStartIndex}{at what index to start the next fetch of query results}
+
+\item{fields}{what data / metadata fields should be collected}
+
+\item{requestUrl}{complete URL of the API request}
+
+\item{webUIRequestUrl}{URL of a web frontend request corresponding to the API request}
+
+\item{apiResponse}{data-frame representation of the JSON response of the API request}
+
+\item{hasMoreMatches}{boolean that signals if more query results can be fetched}
+
+\item{collectedMatches}{matches already fetched from the KorAP-API-server}
+
+\item{kqo}{object obtained from \code{\link{corpusQuery}}}
+
+\item{offset}{start offset for query results to fetch}
+
+\item{maxFetch}{maximum number of query results to fetch}
+
+\item{verbose}{print progress information if true}
+
+\item{x}{KorAPQuery object}
+
+\item{...}{further arguments passed to or from other methods}
+
+\item{object}{KorAPQuery object}
+}
+\value{
+The \code{kqo} input object with updated slots \code{collectedMatches}, \code{apiResponse}, \code{nextStartIndex}, \code{hasMoreMatches}
+}
+\description{
+\code{KorAPQuery} objetcs represent the current state of a query to a KorAP server.
+New \code{KorAPQuery} objects are typically created by the \code{\link{corpusQuery}} method.
+}
+\examples{
+q <- fetchAll(corpusQuery(new("KorAPConnection"), "Ameisenplage"))
+q@collectedMatches
+
+q <- fetchRest(fetchNext(corpusQuery(new("KorAPConnection"), "Ameisenplage")))
+q@collectedMatches
+
+}
+\references{
+\url{https://ids-pub.bsz-bw.de/frontdoor/index/index/docId/9026}
+}