rt/lib/RT/Search/Generic.pm

   1 # {{{ BEGIN BPS TAGGED BLOCK
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2004 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 =head1 NAME
  47
  48   RT::Search::Generic - ;
  49
  50 =head1 SYNOPSIS
  51
  52     use RT::Search::Generic;
  53     my $tickets = RT::Tickets->new($CurrentUser);
  54     my $foo = RT::Search::Generic->new(Argument => $arg,
  55                                        TicketsObj => $tickets);
  56     $foo->Prepare();
  57     while ( my $ticket = $foo->Next ) {
  58         # Do something with each ticket we've found
  59     }
  60
  61
  62 =head1 DESCRIPTION
  63
  64
  65 =head1 METHODS
  66
  67
  68 =begin testing
  69
  70 ok (require RT::Search::Generic);
  71
  72 =end testing
  73
  74
  75 =cut
  76
  77 package RT::Search::Generic;
  78
  79 use strict;
  80
  81 # {{{ sub new
  82 sub new  {
  83   my $proto = shift;
  84   my $class = ref($proto) || $proto;
  85   my $self  = {};
  86   bless ($self, $class);
  87   $self->_Init(@_);
  88   return $self;
  89 }
  90 # }}}
  91
  92 # {{{ sub _Init
  93 sub _Init  {
  94   my $self = shift;
  95   my %args = (
  96            TicketsObj => undef,
  97                Argument => undef,
  98                @_ );
  99
 100   $self->{'TicketsObj'} = $args{'TicketsObj'};
 101   $self->{'Argument'} = $args{'Argument'};
 102 }
 103 # }}}
 104
 105 # {{{ sub Argument
 106
 107 =head2 Argument
 108
 109 Return the optional argument associated with this Search
 110
 111 =cut
 112
 113 sub Argument  {
 114   my $self = shift;
 115   return($self->{'Argument'});
 116 }
 117 # }}}
 118
 119
 120 =head2 TicketsObj
 121
 122 Return the Tickets object passed into this search
 123
 124 =cut
 125
 126 sub TicketsObj {
 127     my $self = shift;
 128     return($self->{'TicketsObj'});
 129 }
 130
 131 # {{{ sub Describe
 132 sub Describe  {
 133   my $self = shift;
 134   return ($self->loc("No description for [_1]", ref $self));
 135 }
 136 # }}}
 137
 138 # {{{ sub Prepare
 139 sub Prepare  {
 140   my $self = shift;
 141   return(1);
 142 }
 143 # }}}
 144
 145 eval "require RT::Search::Generic_Vendor";
 146 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Search/Generic_Vendor.pm});
 147 eval "require RT::Search::Generic_Local";
 148 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Search/Generic_Local.pm});
 149
 150 1;