Yawns::Submission::Notes

• NAME
• SYNOPSIS
• DESCRIPTION
  • new
  • addSubmissionNote
  • getSubmissionNotes
  • deleteSubmissionNotes
  • invalidateCache
• AUTHOR
• LICENSE

NAME

Yawns::Submission::Notes - A module for leaving notes upon submissions.

SYNOPSIS

    #!/usr/bin/perl -w

    use Yawns::Submission::Notes;
    use strict;

    # Create the object.
    my $handle = Yawns::Submission::Notes->new();

    #
    # Add a note to a submissions.
    #
    $handle->addSubmissionNote( submission => 222,
                                note       => "Foo",
                                username   => "Anonymous" );

    #
    # Retrieve all notes stored upon the given submission.
    #
    my $notes = $handle->getSubmissionNotes( 222 );

    #
    # Delete all notes stored against the specified submission.
    #
    $handle->deleteSubmissionNotes( 22 );

DESCRIPTION

This module will store an arbitary block of text as submissio notes.

This is useful for when multiple article administrators wish to communicate over the validity or contents of an article in the submission queue.

new

  Create a new instance of this object.

addSubmissionNote

  Add a note against the given article in the submission queue.

getSubmissionNotes

  Retrieve the notes recorded against the given submission.

deleteSubmissionNotes

  Delete any stored note against the specified submission.

invalidateCache

  Clean any cached content we might have.

AUTHOR

Steve Kemp

http://www.steve.org.uk/

LICENSE

Copyright (c) 2007 by Steve Kemp. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The LICENSE file contains the full text of the license.