Bio/Factory/ApplicationFactoryI.pm

   1 # $Id$
   2 #
   3 # BioPerl module for Bio::Factory::ApplicationFactoryI
   4 #
   5 # Cared for by Heikki Lehvaslaiho <heikki-at-bioperl-dot-org>
   6 #
   7 # Copyright Heikki Lehvaslaiho
   8 #
   9 # You may distribute this module under the same terms as perl itself
  10
  11 # POD documentation - main docs before the code
  12
  13 =head1 NAME
  14
  15 Bio::Factory::ApplicationFactoryI - Interface class for Application Factories
  16
  17 =head1 SYNOPSIS
  18
  19 You wont be using this as an object, but using a derived class.
  20
  21 =head1 DESCRIPTION
  22
  23 Holds common Application Factory attributes in place.
  24
  25 =head1 FEEDBACK
  26
  27 =head2 Mailing Lists
  28
  29 User feedback is an integral part of the evolution of this and other
  30 Bioperl modules. Send your comments and suggestions preferably to the
  31 Bioperl mailing lists  Your participation is much appreciated.
  32
  33   bioperl-l@bioperl.org                  - General discussion
  34   http://bioperl.org/wiki/Mailing_lists  - About the mailing lists
  35
  36 =head2 Reporting Bugs
  37
  38 report bugs to the Bioperl bug tracking system to help us keep track
  39 the bugs and their resolution.  Bug reports can be submitted via the
  40 web:
  41
  42   http://bugzilla.open-bio.org/
  43
  44 =head1 AUTHOR - Heikki Lehvaslaiho
  45
  46 Email:  heikki-at-bioperl-dot-org
  47
  48 =head1 APPENDIX
  49
  50 The rest of the documentation details each of the object
  51 methods. Internal methods are usually preceded with a _
  52
  53 =cut
  54
  55 # Let the code begin...
  56
  57 package Bio::Factory::ApplicationFactoryI;
  58 use strict;
  59
  60 use base qw(Bio::Root::RootI);
  61
  62 =head2  version
  63
  64  Title   : version
  65  Usage   : exit if $prog->version() < 1.8
  66  Function: Determine the version number of the program
  67  Example :
  68  Returns : float or undef
  69  Args    : none
  70
  71 =cut
  72
  73 sub version {
  74     shift->throw_not_implemented();
  75 }
  76
  77 1;