lib/Bio/Factory/ApplicationFactoryI.pm

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