Toolbar

Summary

Bio::EnsEMBL::Pipeline::Status - small object storing job status tags

Package variables

Included modules

Inherit

Synopsis

    my $obj    = new Bio::EnsEMBL::Pipeline::Status
    ('-jobid'              => $jobid,
     '-status'             => $status,
     '-created'            => $created,
     );

Description

Stores the status of a job at a certain time

Methods

Methods description

  Title   : created
  Usage   : $self->created
  Function: Get/set method for the created time
  Returns : int
  Args    : int

  Title   : jobid
  Usage   : $self->jobid
  Function: Get/set method for the jobid
  Returns : int
  Args    : int

  Title   : status
  Usage   : $self->status
  Function: Get/set method for the status string
  Returns : string
  Args    : string

Methods code

sub created {

    my ($self,$arg) = @_;

    if (defined($arg)) {
	$self->{_created} = $arg;
    }

    return $self->{_created};
}

1;

}

sub jobid {

    my ($self,$arg) = @_;

    if (defined($arg)) {
	$self->{_jobid} = $arg;
    }

    return $self->{_jobid};

}

sub new {

  my($class,@args) = @_;
  
   my $self = bless {},$class;

  my ($jobid,$status,$created)  =
      rearrange([qw(JOBID
			    STATUS
			    CREATED
			    )],@args);

  $jobid   || $self->throw("Can't create a status object with no jobid");
  $status  || $self->throw("Can't create a status object for job ".
			   $jobid." with no status string");
  $created || $self->throw("Can't create a status object for job ".
			   $jobid." with no created time");

  $self->jobid             ($jobid);
  $self->status            ($status);
  $self->created           ($created);

  return $self;

}

sub status {

    my ($self,$arg) = @_;

    if (defined($arg)) {
	$self->{_status} = $arg;
    }

    return $self->{_status};

}

General documentation

The rest of the documentation details each of the object
methods. Internal methods are usually preceded with a _