import rt 3.6.4
[freeside.git] / rt / lib / RT / Queues.pm
index ab58d8d..bc5f480 100755 (executable)
-#$Header: /home/cvs/cvsroot/freeside/rt/lib/RT/Queues.pm,v 1.1 2002-08-12 06:17:07 ivan Exp $
+# BEGIN BPS TAGGED BLOCK {{{
+# 
+# COPYRIGHT:
+#  
+# This software is Copyright (c) 1996-2007 Best Practical Solutions, LLC 
+#                                          <jesse@bestpractical.com>
+# 
+# (Except where explicitly superseded by other copyright notices)
+# 
+# 
+# LICENSE:
+# 
+# This work is made available to you under the terms of Version 2 of
+# the GNU General Public License. A copy of that license should have
+# been provided with this software, but in any event can be snarfed
+# from www.gnu.org.
+# 
+# This work is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301 or visit their web page on the internet at
+# http://www.gnu.org/copyleft/gpl.html.
+# 
+# 
+# CONTRIBUTION SUBMISSION POLICY:
+# 
+# (The following paragraph is not intended to limit the rights granted
+# to you to modify and distribute this software under the terms of
+# the GNU General Public License and is only of importance to you if
+# you choose to contribute your changes and enhancements to the
+# community by submitting them to Best Practical Solutions, LLC.)
+# 
+# By intentionally submitting any modifications, corrections or
+# derivatives to this work, or any other work intended for use with
+# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+# you are the copyright holder for those contributions and you grant
+# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
+# royalty-free, perpetual, license to use, copy, create derivative
+# works based on those contributions, and sublicense and distribute
+# those contributions and any derivatives thereof.
+# 
+# END BPS TAGGED BLOCK }}}
+# Autogenerated by DBIx::SearchBuilder factory (by <jesse@bestpractical.com>)
+# WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST.  
+# 
+# !! DO NOT EDIT THIS FILE !!
+#
+
+use strict;
 
-=head1 NAME
 
-  RT::Queues - a collection of RT::Queue objects
+=head1 NAME
 
+  RT::Queues -- Class Description
 =head1 SYNOPSIS
 
-  use RT::Queues;
+  use RT::Queues
 
 =head1 DESCRIPTION
 
 
 =head1 METHODS
 
-
-=begin testing
-
-ok (require RT::TestHarness);
-ok (require RT::Queues);
-
-=end testing
-
 =cut
 
 package RT::Queues;
-use RT::EasySearch;
-@ISA= qw(RT::EasySearch);
 
+use RT::SearchBuilder;
+use RT::Queue;
 
-# {{{ sub _Init
-sub _Init { 
-  my $self = shift;
-  $self->{'table'} = "Queues";
-  $self->{'primary_key'} = "id";
+use vars qw( @ISA );
+@ISA= qw(RT::SearchBuilder);
 
-  # By default, order by name
-  $self->OrderBy( ALIAS => 'main',
-                 FIELD => 'Name',
-                 ORDER => 'ASC');
 
-  return ($self->SUPER::_Init(@_));
+sub _Init {
+    my $self = shift;
+    $self->{'table'} = 'Queues';
+    $self->{'primary_key'} = 'id';
+
+
+    return ( $self->SUPER::_Init(@_) );
 }
-# }}}
 
-# {{{ sub _DoSearch 
 
-=head2 _DoSearch
+=head2 NewItem
 
-  A subclass of DBIx::SearchBuilder::_DoSearch that makes sure that _Disabled rows never get seen unless
-we're explicitly trying to see them.
+Returns an empty new RT::Queue item
 
 =cut
 
-sub _DoSearch {
+sub NewItem {
     my $self = shift;
-    
-    #unless we really want to find disabled rows, make sure we\'re only finding enabled ones.
-    unless($self->{'find_disabled_rows'}) {
-       $self->LimitToEnabled();
-    }
-    
-    return($self->SUPER::_DoSearch(@_));
-    
+    return(RT::Queue->new($self->CurrentUser));
 }
 
-# }}}
-  
+        eval "require RT::Queues_Overlay";
+        if ($@ && $@ !~ qr{^Can't locate RT/Queues_Overlay.pm}) {
+            die $@;
+        };
 
-# {{{ sub Limit 
-sub Limit  {
-  my $self = shift;
-  my %args = ( ENTRYAGGREGATOR => 'AND',
-              @_);
-  $self->SUPER::Limit(%args);
-}
-# }}}
+        eval "require RT::Queues_Vendor";
+        if ($@ && $@ !~ qr{^Can't locate RT/Queues_Vendor.pm}) {
+            die $@;
+        };
 
-# {{{ sub NewItem 
-sub NewItem  {
-  my $self = shift;
-  my $item;
+        eval "require RT::Queues_Local";
+        if ($@ && $@ !~ qr{^Can't locate RT/Queues_Local.pm}) {
+            die $@;
+        };
 
-  use RT::Queue;
-  $item = new RT::Queue($self->CurrentUser);
-  return($item);
-}
-# }}}
 
-# {{{ sub Next 
 
-=head2 Next
 
-Returns the next queue that this user can see.
+=head1 SEE ALSO
+
+This class allows "overlay" methods to be placed
+into the following files _Overlay is for a System overlay by the original author,
+_Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations.  
+
+These overlay files can contain new subs or subs to replace existing subs in this module.
+
+Each of these files should begin with the line 
+
+   no warnings qw(redefine);
+
+so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
+
+RT::Queues_Overlay, RT::Queues_Vendor, RT::Queues_Local
 
 =cut
-  
-sub Next {
-    my $self = shift;
-    
-    
-    my $Queue = $self->SUPER::Next();
-    if ((defined($Queue)) and (ref($Queue))) {
-
-       if ($Queue->CurrentUserHasRight('SeeQueue')) {
-           return($Queue);
-       }
-       
-       #If the user doesn't have the right to show this queue
-       else {  
-           return($self->Next());
-       }
-    }
-    #if there never was any queue
-    else {
-       return(undef);
-    }  
-    
-}
-# }}}
 
-1;
 
+1;