Initial commit 4.0.5-3
[usit-rt.git] / lib / RT / Search.pm
1 # BEGIN BPS TAGGED BLOCK {{{
2 #
3 # COPYRIGHT:
4 #
5 # This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC
6 #                                          <sales@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/licenses/old-licenses/gpl-2.0.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
49 =head1 NAME
50
51   RT::Search - generic baseclass for searches;
52
53 =head1 SYNOPSIS
54
55     use RT::Search;
56     my $tickets = RT::Tickets->new($CurrentUser);
57     my $foo = RT::Search->new(Argument => $arg,
58                               TicketsObj => $tickets);
59     $foo->Prepare();
60     while ( my $ticket = $foo->Next ) {
61         # Do something with each ticket we've found
62     }
63
64
65 =head1 DESCRIPTION
66
67
68 =head1 METHODS
69
70
71
72
73 =cut
74
75 package RT::Search;
76
77 use strict;
78 use warnings;
79
80 sub new {
81     my $proto = shift;
82     my $class = ref($proto) || $proto;
83     my $self  = {};
84     bless( $self, $class );
85     $self->_Init(@_);
86     return $self;
87 }
88
89 sub _Init {
90     my $self = shift;
91     my %args = (
92         TicketsObj => undef,
93         Argument   => undef,
94         @_
95     );
96
97     $self->{'TicketsObj'} = $args{'TicketsObj'};
98     $self->{'Argument'}   = $args{'Argument'};
99 }
100
101 =head2 Argument
102
103 Return the optional argument associated with this Search
104
105 =cut
106
107 sub Argument {
108     my $self = shift;
109     return ( $self->{'Argument'} );
110 }
111
112 =head2 TicketsObj
113
114 Return the Tickets object passed into this search
115
116 =cut
117
118 sub TicketsObj {
119     my $self = shift;
120     return ( $self->{'TicketsObj'} );
121 }
122
123 sub Describe {
124     my $self = shift;
125     return ( $self->loc( "No description for [_1]", ref $self ) );
126 }
127
128 sub Prepare {
129     my $self = shift;
130     return (1);
131 }
132
133 RT::Base->_ImportOverlays();
134
135 1;