rt/lib/RT/Search/Generic.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2007 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., 51 Franklin Street, Fifth Floor, Boston, MA
  26 # 02110-1301 or visit their web page on the internet at
  27 # http://www.gnu.org/copyleft/gpl.html.
  28 #
  29 #
  30 # CONTRIBUTION SUBMISSION POLICY:
  31 #
  32 # (The following paragraph is not intended to limit the rights granted
  33 # to you to modify and distribute this software under the terms of
  34 # the GNU General Public License and is only of importance to you if
  35 # you choose to contribute your changes and enhancements to the
  36 # community by submitting them to Best Practical Solutions, LLC.)
  37 #
  38 # By intentionally submitting any modifications, corrections or
  39 # derivatives to this work, or any other work intended for use with
  40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  41 # you are the copyright holder for those contributions and you grant
  42 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  43 # royalty-free, perpetual, license to use, copy, create derivative
  44 # works based on those contributions, and sublicense and distribute
  45 # those contributions and any derivatives thereof.
  46 #
  47 # END BPS TAGGED BLOCK }}}
  48 =head1 NAME
  49
  50   RT::Search::Generic - ;
  51
  52 =head1 SYNOPSIS
  53
  54     use RT::Search::Generic;
  55     my $tickets = RT::Tickets->new($CurrentUser);
  56     my $foo = RT::Search::Generic->new(Argument => $arg,
  57                                        TicketsObj => $tickets);
  58     $foo->Prepare();
  59     while ( my $ticket = $foo->Next ) {
  60         # Do something with each ticket we've found
  61     }
  62
  63
  64 =head1 DESCRIPTION
  65
  66
  67 =head1 METHODS
  68
  69
  70 =begin testing
  71
  72 ok (require RT::Search::Generic);
  73
  74 =end testing
  75
  76
  77 =cut
  78
  79 package RT::Search::Generic;
  80
  81 use strict;
  82
  83 # {{{ sub new
  84 sub new  {
  85   my $proto = shift;
  86   my $class = ref($proto) || $proto;
  87   my $self  = {};
  88   bless ($self, $class);
  89   $self->_Init(@_);
  90   return $self;
  91 }
  92 # }}}
  93
  94 # {{{ sub _Init
  95 sub _Init  {
  96   my $self = shift;
  97   my %args = (
  98            TicketsObj => undef,
  99                Argument => undef,
 100                @_ );
 101
 102   $self->{'TicketsObj'} = $args{'TicketsObj'};
 103   $self->{'Argument'} = $args{'Argument'};
 104 }
 105 # }}}
 106
 107 # {{{ sub Argument
 108
 109 =head2 Argument
 110
 111 Return the optional argument associated with this Search
 112
 113 =cut
 114
 115 sub Argument  {
 116   my $self = shift;
 117   return($self->{'Argument'});
 118 }
 119 # }}}
 120
 121
 122 =head2 TicketsObj
 123
 124 Return the Tickets object passed into this search
 125
 126 =cut
 127
 128 sub TicketsObj {
 129     my $self = shift;
 130     return($self->{'TicketsObj'});
 131 }
 132
 133 # {{{ sub Describe
 134 sub Describe  {
 135   my $self = shift;
 136   return ($self->loc("No description for [_1]", ref $self));
 137 }
 138 # }}}
 139
 140 # {{{ sub Prepare
 141 sub Prepare  {
 142   my $self = shift;
 143   return(1);
 144 }
 145 # }}}
 146
 147 eval "require RT::Search::Generic_Vendor";
 148 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Search/Generic_Vendor.pm});
 149 eval "require RT::Search::Generic_Local";
 150 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Search/Generic_Local.pm});
 151
 152 1;