1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2017 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 }}}
49 package RT::CustomFieldValues;
54 use base 'RT::SearchBuilder';
56 use RT::CustomFieldValue;
58 sub Table { 'CustomFieldValues'}
63 # By default, order by SortOrder
76 return ( $self->SUPER::_Init(@_) );
78 # {{{ sub LimitToCustomField
80 =head2 LimitToCustomField FIELD
82 Limits the returned set to values for the custom field with Id FIELD
86 sub LimitToCustomField {
90 FIELD => 'CustomField',
96 =head2 SetCustomFieldObject
98 Store the CustomField object which loaded this CustomFieldValues collection.
99 Consumers of CustomFieldValues collection (such as External Custom Fields)
100 can now work out how they were loaded (off a Queue or Ticket or something else)
101 by inspecting the CustomField.
105 sub SetCustomFieldObject {
107 return $self->{'custom_field'} = shift;
110 =head2 CustomFieldObject
112 Returns the CustomField object used to load this CustomFieldValues collection.
113 Relies on $CustomField->Values having been called, is not set on manual loads.
117 sub CustomFieldObject {
119 return $self->{'custom_field'};
124 Propagates the CustomField object from the Collection
125 down to individual CustomFieldValue objects.
133 $CFV->SetCustomFieldObj($self->CustomFieldObject);
135 push @{$self->{'items'}}, $CFV;
140 RT::Base->_ImportOverlays();