1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
6 # <sales@bestpractical.com>
8 # (Except where explicitly superseded by other copyright notices)
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
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.
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.
30 # CONTRIBUTION SUBMISSION POLICY:
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.)
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.
47 # END BPS TAGGED BLOCK }}}
51 RT::SavedSearch - an API for saving and retrieving search form values.
59 SavedSearch is an object based on L<RT::SharedSetting> that can belong
60 to either an L<RT::User> or an L<RT::Group>. It consists of an ID,
61 a description, and a number of search parameters.
65 package RT::SavedSearch;
69 use base qw/RT::SharedSetting/;
75 An object of this class is called "search"
79 sub ObjectName { "search" }
83 $self->{'Type'} = $self->{'Attribute'}->SubValue('SearchType');
91 my $params = $args->{'SearchParams'};
93 $params->{'SearchType'} = $args->{'Type'} || 'Ticket';
95 return $object->AddAttribute(
96 'Name' => 'SavedSearch',
97 'Description' => $args->{'Name'},
103 sub UpdateAttribute {
106 my $params = $args->{'SearchParams'} || {};
108 my ($status, $msg) = $self->{'Attribute'}->SetSubValues(%$params);
110 if ($status && $args->{'Name'}) {
111 ($status, $msg) = $self->{'Attribute'}->SetDescription($args->{'Name'});
114 return ($status, $msg);
119 Returns the type of this search, e.g. 'Ticket'. Useful for denoting the
120 saved searches that are relevant to a particular search page.
126 return $self->{'Type'};
129 RT::Base->_ImportOverlays();