File Coverage

blib/lib/Schedule/LongSteps/Storage.pm

Criterion	Covered	Total	%
statement	10	16	62.5
branch			n/a
condition			n/a
subroutine	4	7	57.1
pod	4	4	100.0
total	18	27	66.6

package Schedule::LongSteps::Storage;
$Schedule::LongSteps::Storage::VERSION = '0.023';
use Moose;

=head1 NAME

Schedule::LongSteps::Storage - An abstract storage class for steps

=cut

use Data::UUID;

has 'uuid' => ( is => 'ro', isa => 'Data::UUID', lazy_build => 1);

sub _build_uuid{
    my ($self) = @_;
    return Data::UUID->new();
}



=head2 prepare_due_processes

Mark the processes that are due to run as 'running' and
returns an array of stored processes.

Users: Note that this is meant to be used by L<Schedule::LongSteps>, and not intended
to be called directly.

Implementors: You will have to implement this method should you wish to implement
a new process storage backend.

=cut

sub prepare_due_processes{
    my ($self) = @_;
    die "Please implement this in $self";
}

=head2 create_process

Creates and return a new stored process.

=cut

sub create_process{
    my ($self, $properties) = @_;
    die "Please implement this in $self";
}

=head2 find_process

Returns a stored process based on the given ID, or undef if no such thing exists.

Usage:

 my $stored_process = $this->find_process( $pid );

=cut

sub find_process{
    my ($self, $pid) = @_;
    die "Please implement this in $self";
}


=head2 update_process

Updates the given stored process (as returned by 'find_process')
with the given properties.

Usage:

 $this->update_process( $process , { run_at => DateTime->now(), .. } );

=cut

sub update_process{
    my ($self, $process, $properties) = @_;
    $process->update( $properties );
}

__PACKAGE__->meta()->make_immutable();