root/trunk/antimatter/tim/Modules/SFLC/TimeTracker/Output.pm

# Copyright (C) 2005   Software Freedom Law Center, Inc.
#  Author: Bradley M. Kuhn <bkuhn@softwarefreedom.org>
#
#  This software gives you freedom; it is licensed to you under version
#  3 of the GNU Affero General Public License.
#
#  This software is distributed WITHOUT ANY WARRANTY, without even the
#  implied warranties of MERCHANTABILITY and FITNESS FOR A PARTICULAR
#  PURPOSE.  See the GNU Affero General Public License for further
#  details.
#
# You should have received a copy of the GNU Affero General Public
# License, version 3 along with this software.  If not, see
# <http://www.gnu.org/licenses/>.
use strict;
use warnings;

package SFLC::TimeTracker::Output;

use Carp;

sub new {
  my($class) = shift;
  my(%input) = @_;

  if (not exists $input{status}) {
    croak "invalid  for 'status' in $class";
  }

  if (not exists $input{type}) {
    croak "invalid  for 'type' in $class";
  }
  if (not defined $input{object} and not ref $input{object}) {
    croak "invalid or non existant value for 'object' in $class";
  }
  return bless { object => $input{object}, type => $input{type},
                 status => $input{status} }, $class;
}

sub object {
  my $self = shift;
  return $self->{object};
}
sub type {
  my $self = shift;
  return $self->{type};
}
sub status {
  my $self = shift;
  return $self->{status};
}
sub get {
  my($self, $field) = @_;
  if ($field =~ /^(?:status|type|object)$/) {
    return $self->{$field};
  } else {
    croak "invalid field, \"$field\"";
  }
}
sub set {
  my($self, $field, $value) = @_;
  if ($field =~ /^(?:status|object)$/) {
     $self->{$field} = $value;
  } else {
    croak "invalid field, \"$field\"";
  }
}
sub prettyPrintIRC ($$) {
  my($self, $now) = @_;

  return "Got status of " . $self->status . " and type of " . $self->type 
    . " on $now, and called prettyPrintIRC in base class.  REPORT THIS!";
}
# action should return 1 if the action needed to take on this Output item 
#  is complete and therefore we can tell our container that it need not worry
#  about us anymore after giving output.
sub action {
  return { };
}

1;
__END__

#
# Local variables:
# compile-command: "perl -I ../../../Modules -c Output.pm"
# End: