rt/lib/RT/Search/Generic.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2005 Best Practical Solutions, LLC
   6 #                                          <jesse@bestpractical.com>
   7 #
   8 # (Except where explicitly superseded by other copyright notices)
   9 #
  10 #
  11 # LICENSE:
  12 #
  13 # This work is made available to you under the terms of Version 2 of
  14 # the GNU General Public License. A copy of that license should have
  15 # been provided with this software, but in any event can be snarfed
  16 # from www.gnu.org.
  17 #
  18 # This work is distributed in the hope that it will be useful, but
  19 # WITHOUT ANY WARRANTY; without even the implied warranty of
  20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21 # General Public License for more details.
  22 #
  23 # You should have received a copy of the GNU General Public License
  24 # along with this program; if not, write to the Free Software
  25 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  26 #
  27 #
  28 # CONTRIBUTION SUBMISSION POLICY:
  29 #
  30 # (The following paragraph is not intended to limit the rights granted
  31 # to you to modify and distribute this software under the terms of
  32 # the GNU General Public License and is only of importance to you if
  33 # you choose to contribute your changes and enhancements to the
  34 # community by submitting them to Best Practical Solutions, LLC.)
  35 #
  36 # By intentionally submitting any modifications, corrections or
  37 # derivatives to this work, or any other work intended for use with
  38 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  39 # you are the copyright holder for those contributions and you grant
  40 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  41 # royalty-free, perpetual, license to use, copy, create derivative
  42 # works based on those contributions, and sublicense and distribute
  43 # those contributions and any derivatives thereof.
  44 #
  45 # END BPS TAGGED BLOCK }}}
  46
  47 =head1 NAME
  48
  49   RT::Search::Generic - ;
  50
  51 =head1 SYNOPSIS
  52
  53     use RT::Search::Generic;
  54     my $tickets = RT::Tickets->new($CurrentUser);
  55     my $foo = RT::Search::Generic->new(Argument => $arg,
  56                                        TicketsObj => $tickets);
  57     $foo->Prepare();
  58     while ( my $ticket = $foo->Next ) {
  59         # Do something with each ticket we've found
  60     }
  61
  62
  63 =head1 DESCRIPTION
  64
  65
  66 =head1 METHODS
  67
  68
  69 =begin testing
  70
  71 ok (require RT::Search::Generic);
  72
  73 =end testing
  74
  75
  76 =cut
  77
  78 package RT::Search::Generic;
  79
  80 use strict;
  81
  82 # {{{ sub new
  83 sub new  {
  84   my $proto = shift;
  85   my $class = ref($proto) || $proto;
  86   my $self  = {};
  87   bless ($self, $class);
  88   $self->_Init(@_);
  89   return $self;
  90 }
  91 # }}}
  92
  93 # {{{ sub _Init
  94 sub _Init  {
  95   my $self = shift;
  96   my %args = (
  97            TicketsObj => undef,
  98                Argument => undef,
  99                @_ );
 100
 101   $self->{'TicketsObj'} = $args{'TicketsObj'};
 102   $self->{'Argument'} = $args{'Argument'};
 103 }
 104 # }}}
 105
 106 # {{{ sub Argument
 107
 108 =head2 Argument
 109
 110 Return the optional argument associated with this Search
 111
 112 =cut
 113
 114 sub Argument  {
 115   my $self = shift;
 116   return($self->{'Argument'});
 117 }
 118 # }}}
 119
 120
 121 =head2 TicketsObj
 122
 123 Return the Tickets object passed into this search
 124
 125 =cut
 126
 127 sub TicketsObj {
 128     my $self = shift;
 129     return($self->{'TicketsObj'});
 130 }
 131
 132 # {{{ sub Describe
 133 sub Describe  {
 134   my $self = shift;
 135   return ($self->loc("No description for [_1]", ref $self));
 136 }
 137 # }}}
 138
 139 # {{{ sub Prepare
 140 sub Prepare  {
 141   my $self = shift;
 142   return(1);
 143 }
 144 # }}}
 145
 146 eval "require RT::Search::Generic_Vendor";
 147 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Search/Generic_Vendor.pm});
 148 eval "require RT::Search::Generic_Local";
 149 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Search/Generic_Local.pm});
 150
 151 1;