Upgrade to 4.2.2

[usit-rt.git] / lib / RT / Topics.pm

# BEGIN BPS TAGGED BLOCK {{{
#
# COPYRIGHT:
#
# This software is Copyright (c) 1996-2014 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 }}}

use strict;
use warnings;
no warnings qw(redefine);

package RT::Topics;
use base 'RT::SearchBuilder';

sub Table {'Topics'}


# {{{ LimitToObject

=head2 LimitToObject OBJ

Find all Topics hung off of the given Object

=cut

sub LimitToObject {
    my $self = shift;
    my $object = shift;

    my $subclause = "limittoobject";
    
    $self->_OpenParen($subclause);
    $self->Limit(FIELD => 'ObjectId',
                 VALUE => $object->Id,
                 SUBCLAUSE => $subclause);
    $self->Limit(FIELD => 'ObjectType',
                 VALUE => ref($object),
                 SUBCLAUSE => $subclause,
                 ENTRYAGGREGATOR => 'AND');
    $self->_CloseParen($subclause);
}

# }}}


# {{{ LimitToKids

=head2 LimitToKids TOPIC

Find all Topics which are immediate children of Id TOPIC.  Note this
does not do the recursive query of their kids, etc.

=cut

sub LimitToKids {
    my $self = shift;
    my $topic = shift;
    
    $self->Limit(FIELD => 'Parent',
                 VALUE => $topic);
}

# }}}

RT::Base->_ImportOverlays();

1;