---
name: "HTTP::OAI::Record"
section: "3pm"
platform: "linux"
package: "libhttp-oai-perl"
version: "4.13-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/HTTP::OAI::Record"
---

# HTTP::OAI::Record(3pm)

Encapsulates an OAI record

## NAME

HTTP::OAI::Record - Encapsulates an OAI record

## SYNOPSIS

```
        use HTTP::OAI::Record;
        # Create a new HTTP::OAI Record
        my $r = new HTTP::OAI::Record();
        $r->header->identifier('oai:myarchive.org:oid-233');
        $r->header->datestamp('2002-04-01');
        $r->header->setSpec('all:novels');
        $r->header->setSpec('all:books');
        $r->metadata(new HTTP::OAI::Metadata(dom=>$md));
        $r->about(new HTTP::OAI::Metadata(dom=>$ab));
```

## METHODS

- $r = new HTTP::OAI::Record( %opts )

  This constructor method returns a new HTTP::OAI::Record object.

  Options (see methods below):

  ```
          header => $header
          metadata => $metadata
          about => [$about]
  ```

- $r-\>header(\[HTTP::OAI::Header\])

  Returns and optionally sets the record header (an HTTP::OAI::Header object).

- $r-\>metadata(\[HTTP::OAI::Metadata\])

  Returns and optionally sets the record metadata (an HTTP::OAI::Metadata object).

- $r-\>about(\[HTTP::OAI::Metadata\])

  Optionally adds a new About record (an HTTP::OAI::Metadata object) and returns an array of objects (may be empty).

### Header Accessor Methods

These methods are equivalent to `"$rec->header->$method([$value])"`.

- $r-\>identifier(\[$identifier\])

  Get and optionally set the record OAI identifier.

- $r-\>datestamp(\[$datestamp\])

  Get and optionally set the record datestamp.

- $r-\>status(\[$status\])

  Get and optionally set the record status (valid values are 'deleted' or undef).

- $r-\>**is\_deleted()**

  Returns whether this record's status is deleted.