---
name: "SRU::Request::Scan"
section: "3pm"
platform: "linux"
package: "libsru-perl"
version: "1.01-3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/SRU::Request::Scan"
---

# SRU::Request::Scan(3pm)

A class for representing SRU scan requests

## NAME

SRU::Request::Scan - A class for representing SRU scan requests

## SYNOPSIS

```
    ## creating a new request
    my $request = SRU::Request::Scan->new();
```

## DESCRIPTION

SRU::Request::Scan is a class for representing SRU 'scan' requests.

## METHODS

### new()

The constructor, which you can pass the parameters: version, scanClause responsePosition, maximumTerms, stylesheet, extraRequestData.

```
    my $request = SRU::Request::Explain->new(
        version     => '1.1',
        scanClause  => 'horses',
    );
```

### version()

### scanClause()

### responsePosition()

### maximumTerms()

### stylesheet()

### extraRequestData()

### validParams()

### cql()

Fetch the root node of the CQL parse tree for the scan clause.

## COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Ed Summers.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.