import rt 3.8.10
[freeside.git] / rt / lib / RT / Scrips.pm
index 90be847..7e63217 100755 (executable)
-# Copyright 1999-2001 Jesse Vincent <jesse@fsck.com>
-# Released under the terms of the GNU Public License
-# $Header: /home/cvs/cvsroot/freeside/rt/lib/RT/Scrips.pm,v 1.1 2002-08-12 06:17:07 ivan Exp $
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
+#                                          <sales@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/licenses/old-licenses/gpl-2.0.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::Scrips - a collection of RT Scrip objects
+=head1 NAME
 
+  RT::Scrips -- Class Description
 =head1 SYNOPSIS
 
-  use RT::Scrips;
+  use RT::Scrips
 
 =head1 DESCRIPTION
 
 
 =head1 METHODS
 
+=cut
 
-=begin testing
+package RT::Scrips;
 
-ok (require RT::TestHarness);
-ok (require RT::Scrips);
+use RT::SearchBuilder;
+use RT::Scrip;
 
-=end testing
+use vars qw( @ISA );
+@ISA= qw(RT::SearchBuilder);
 
-=cut
 
-package RT::Scrips;
-use RT::EasySearch;
-use RT::Scrip;
-@ISA= qw(RT::EasySearch);
+sub _Init {
+    my $self = shift;
+    $self->{'table'} = 'Scrips';
+    $self->{'primary_key'} = 'id';
 
 
-# {{{ sub _Init
-sub _Init { 
-  my $self = shift;
-  $self->{'table'} = "Scrips";
-  $self->{'primary_key'} = "id";
-  return ( $self->SUPER::_Init(@_));
+    return ( $self->SUPER::_Init(@_) );
 }
-# }}}
 
-# {{{ sub LimitToQueue 
 
-=head2 LimitToQueue
+=head2 NewItem
 
-Takes a queue id (numerical) as its only argument. Makes sure that 
-Scopes it pulls out apply to this queue (or another that you've selected with
-another call to this method
+Returns an empty new RT::Scrip item
 
 =cut
 
-sub LimitToQueue  {
-   my $self = shift;
-  my $queue = shift;
-  $self->Limit (ENTRYAGGREGATOR => 'OR',
-               FIELD => 'Queue',
-               VALUE => "$queue")
-      if defined $queue;
-  
+sub NewItem {
+    my $self = shift;
+    return(RT::Scrip->new($self->CurrentUser));
 }
-# }}}
+RT::Base->_ImportOverlays();
 
-# {{{ sub LimitToGlobal
+=head1 SEE ALSO
 
-=head2 LimitToGlobal
+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.  
 
-Makes sure that 
-Scopes it pulls out apply to all queues (or another that you've selected with
-another call to this method or LimitToQueue
+These overlay files can contain new subs or subs to replace existing subs in this module.
 
-=cut
-
-
-sub LimitToGlobal  {
-   my $self = shift;
-  $self->Limit (ENTRYAGGREGATOR => 'OR',
-               FIELD => 'Queue',
-               VALUE => 0);
-  
-}
-# }}}
+Each of these files should begin with the line 
 
-# {{{ sub NewItem 
-sub NewItem  {
-  my $self = shift;
-  
-  return(new RT::Scrip($self->CurrentUser));
-}
-# }}}
+   no warnings qw(redefine);
 
-# {{{ sub Next 
+so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
 
-=head2 Next
-
-Returns the next scrip that this user can see.
+RT::Scrips_Overlay, RT::Scrips_Vendor, RT::Scrips_Local
 
 =cut
-  
-sub Next {
-    my $self = shift;
-    
-    
-    my $Scrip = $self->SUPER::Next();
-    if ((defined($Scrip)) and (ref($Scrip))) {
-
-       if ($Scrip->CurrentUserHasRight('ShowScrips')) {
-           return($Scrip);
-       }
-       
-       #If the user doesn't have the right to show this scrip
-       else {  
-           return($self->Next());
-       }
-    }
-    #if there never was any scrip
-    else {
-       return(undef);
-    }  
-    
-}
-# }}}
 
-1;
 
+1;