Ignore:
Timestamp:
02/25/13 20:04:38 (11 years ago)
Author:
oschonef
Message:
  • update copyright
  • fix some whitespace
File:
1 edited

Legend:

Unmodified
Added
Removed
  • SRUServer/trunk/src/main/java/eu/clarin/sru/server/SRURequest.java

    r2246 r2623  
    11/**
    2  * This software is copyright (c) 2011 by
     2 * This software is copyright (c) 2011-2013 by
    33 *  - Institut fuer Deutsche Sprache (http://www.ids-mannheim.de)
    44 * This is free software. You can redistribute it
     
    3232     * Get the <em>operation</em> parameter of this request. Available for
    3333     * <em>explain</em>, <em>searchRetrieve</em> and <em>scan</em> requests.
    34      * 
     34     *
    3535     * @return the operation
    3636     * @see SRUOperation
     
    4242     * Get the <em>version</em> parameter of this request. Available for
    4343     * <em>explain</em>, <em>searchRetrieve</em> and <em>scan</em> requests.
    44      * 
     44     *
    4545     * @return the version
    4646     * @see SRUVersion
     
    5151    /**
    5252     * Check if this request is of a specific version.
    53      * 
     53     *
    5454     * @param version
    5555     *            the version to check
     
    6565     * Check if version of this request is at least <em>min</em> and at most
    6666     * <em>max</em>.
    67      * 
     67     *
    6868     * @param min
    6969     *            the minimum version
     
    8383     * Get the <em>recordPacking</em> parameter of this request. Only available
    8484     * for <em>explain</em> and <em>searchRetrieve</em> requests.
    85      * 
     85     *
    8686     * @return the record packing method
    8787     * @see SRURecordPacking
     
    9393     * Get the <em>query</em> parameter of this request. Only available for
    9494     * <em>searchRetrieve</em> requests.
    95      * 
     95     *
    9696     * @return the parsed query or <code>null</code> if not a
    9797     *         <em>searchRetrieve</em> request
     
    103103     * Get the <em>startRecord</em> parameter of this request. Only available
    104104     * for <em>searchRetrieve</em> requests.
    105      * 
     105     *
    106106     * @return the number of the start record or <code>-1</code> if no value was
    107107     *         supplied for this request
     
    114114     * for <em>searchRetrieve</em> requests. If no value was supplied with the
    115115     * request, the server will automatically set a default value.
    116      * 
     116     *
    117117     * @return the maximum number of records
    118118     */
     
    123123     * Get the <em>recordSchema</em> parameter of this request. Only available
    124124     * for <em>searchRetrieve</em> requests.
    125      * 
     125     *
    126126     * @return the record schema name or <code>null</code> if no value was
    127127     *         supplied for this request
     
    135135     * parameter of this request. Only available for <em>searchRetrieve</em>
    136136     * requests.
    137      * 
     137     *
    138138     * @return the record schema identifier or <code>null</code> if no
    139139     *         <em>recordSchema</em> parameter was supplied for this request
     
    146146     * Get the <em>recordXPath</em> parameter of this request. Only available
    147147     * for <em>searchRetrieve</em> requests and version 1.1 requests.
    148      * 
     148     *
    149149     * @return the record XPath or <code>null</code> of no value was supplied
    150150     *         for this request
     
    156156     * Get the <em>resultSetTTL</em> parameter of this request. Only available
    157157     * for <em>searchRetrieve</em> requests.
    158      * 
     158     *
    159159     * @return the result set TTL or <code>-1</code> if no value was supplied
    160160     *         for this request
     
    166166     * Get the <em>sortKeys</em> parameter of this request. Only available for
    167167     * <em>searchRetrieve</em> requests and version 1.1 requests.
    168      * 
     168     *
    169169     * @return the record XPath or <code>null</code> of no value was supplied
    170170     *         for this request
     
    176176     * Get the <em>scanClause</em> parameter of this request. Only available for
    177177     * <em>scan</em> requests.
    178      * 
     178     *
    179179     * @return the parsed scan clause or <code>null</code> if not a
    180180     *         <em>scan</em> request
     
    186186     * Get the <em>responsePosition</em> parameter of this request. Only
    187187     * available for <em>scan</em> requests.
    188      * 
     188     *
    189189     * @return the response position or <code>-1</code> if no value was supplied
    190190     *         for this request
     
    196196     * Get the <em>maximumTerms</em> parameter of this request. Available for
    197197     * any type of request.
    198      * 
     198     *
    199199     * @return the maximum number of terms or <code>-1</code> if no value was
    200200     *         supplied for this request
     
    206206     * Get the <em>stylesheet</em> parameter of this request. Available for
    207207     * <em>explain</em>, <em>searchRetrieve</em> and <em>scan</em> requests.
    208      * 
     208     *
    209209     * @return the stylesheet or <code>null</code> if no value was supplied for
    210210     *         this request
     
    216216     * Get the protocol schema which was used of this request. Available for
    217217     * <em>explain</em>, <em>searchRetrieve</em> and <em>scan</em> requests.
    218      * 
     218     *
    219219     * @return the protocol scheme
    220220     */
     
    225225     * Get the names of extra parameters of this request. Available for
    226226     * <em>explain</em>, <em>searchRetrieve</em> and <em>scan</em> requests.
    227      * 
     227     *
    228228     * @return a possibly empty list of parameter names
    229229     */
     
    234234     * Get the value of an extra parameter of this request. Available for
    235235     * <em>explain</em>, <em>searchRetrieve</em> and <em>scan</em> requests.
    236      * 
     236     *
    237237     * @param name
    238238     *            name of the extra parameter. Must be prefixed with
     
    250250    /**
    251251     * Get the raw client request information from the servlet container.
    252      * 
     252     *
    253253     * @return the servlet request
    254254     */
Note: See TracChangeset for help on using the changeset viewer.