Mark A. Stratman > WWW-ASN > WWW::ASN::Jurisdiction

Download:
WWW-ASN-0.01.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

WWW::ASN::Jurisdiction - Represents a state, organization, or other entity that publishes standards

SYNOPSIS ^

    use WWW::ASN;

    my $asn = WWW::ASN->new();
    for my $jurisdiction ($asn->jurisdictions) {
        say $jurisdiction->name,
            " ( ", $jurisdiction->abbreviation, ")",
            " Type: ", $jurisdiction->type,
            " id: ", $jurisdiction->id;

        foreach my $document (@{ $jurisdiction->documents }) {
            ...;
        }
    }

ATTRIBUTES ^

abbreviation

Required. An abbreviation for the jurisdiction.

e.g. "AL", "CCSS"

name

The name of the jurisdiction. This is typically the state or organization name.

e.g. "Alabama", "Common Core State Standards"

type

e.g. "U.S. States and Territories", "Organization", "Country"

id

This is a globally unique URI for this jurisdiction.

METHODS ^

documents

    my @docs = @{
        $jurisdiction->documents({
            status => 'published',
        })
    };

Returns an array reference of WWW::ASN::Document objects.

Optionally, this method accepts a hash reference containing any of the following arguments:

status

Can be one of: published, draft, or deprecated.

Alternatively, you may provide statusURI (but don't worry if you don't know what this is).

subject

Can be a WWW::ASN::Subject object or the string name of the subject.

States and other standards jurisdictions often are not very consistent, and may have documents categorized under a number of very similar subjects. In general, this option is not terribly useful for searching (e.g. don't search for "math" with the expectation that you're receiving all math-related standards documents).

Alternatively, you may provide subjectURI (but don't worry if you don't know what this is).

cache_file

Path to a file used as a cache for this search.

The name of a file containing the XML data from the last time this was called with the same jurisdiction, subject, and status options.

If the file does not exist, it will be created.

See "Cache files" in WWW::ASN for more details.

AUTHOR ^

Mark A. Stratman, <stratman at gmail.com>

SEE ALSO ^

WWW::ASN

WWW::ASN::Document

WWW::ASN::Subject

LICENSE AND COPYRIGHT ^

Copyright 2012 Mark A. Stratman.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

syntax highlighting: