rt/lib/RT/ObjectTopic.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC
   6 #                                          <sales@bestpractical.com>
   7 #
   8 # (Except where explicitly superseded by other copyright notices)
   9 #
  10 #
  11 # LICENSE:
  12 #
  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
  16 # from www.gnu.org.
  17 #
  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.
  22 #
  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.
  28 #
  29 #
  30 # CONTRIBUTION SUBMISSION POLICY:
  31 #
  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.)
  37 #
  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.
  46 #
  47 # END BPS TAGGED BLOCK }}}
  48
  49 # Autogenerated by DBIx::SearchBuilder factory (by <jesse@bestpractical.com>)
  50 # WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST.
  51 #
  52 # !! DO NOT EDIT THIS FILE !!
  53 #
  54
  55
  56 =head1 NAME
  57
  58 RT::ObjectTopic
  59
  60
  61 =head1 SYNOPSIS
  62
  63 =head1 DESCRIPTION
  64
  65 =head1 METHODS
  66
  67 =cut
  68
  69 no warnings 'redefine';
  70 package RT::ObjectTopic;
  71 use RT::Record;
  72 use RT::Topic;
  73
  74
  75 use base qw( RT::Record );
  76
  77 sub _Init {
  78   my $self = shift;
  79
  80   $self->Table('ObjectTopics');
  81   $self->SUPER::_Init(@_);
  82 }
  83
  84
  85
  86
  87
  88 =head2 Create PARAMHASH
  89
  90 Create takes a hash of values and creates a row in the database:
  91
  92   int(11) 'Topic'.
  93   varchar(64) 'ObjectType'.
  94   int(11) 'ObjectId'.
  95
  96 =cut
  97
  98
  99
 100
 101 sub Create {
 102     my $self = shift;
 103     my %args = (
 104                 Topic => '0',
 105                 ObjectType => '',
 106                 ObjectId => '0',
 107
 108                   @_);
 109     $self->SUPER::Create(
 110                          Topic => $args{'Topic'},
 111                          ObjectType => $args{'ObjectType'},
 112                          ObjectId => $args{'ObjectId'},
 113 );
 114
 115 }
 116
 117
 118
 119 =head2 id
 120
 121 Returns the current value of id.
 122 (In the database, id is stored as int(11).)
 123
 124
 125 =cut
 126
 127
 128 =head2 Topic
 129
 130 Returns the current value of Topic.
 131 (In the database, Topic is stored as int(11).)
 132
 133
 134
 135 =head2 SetTopic VALUE
 136
 137
 138 Set Topic to VALUE.
 139 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 140 (In the database, Topic will be stored as a int(11).)
 141
 142
 143 =cut
 144
 145
 146 =head2 TopicObj
 147
 148 Returns the Topic Object which has the id returned by Topic
 149
 150
 151 =cut
 152
 153 sub TopicObj {
 154         my $self = shift;
 155         my $Topic =  RT::Topic->new($self->CurrentUser);
 156         $Topic->Load($self->Topic());
 157         return($Topic);
 158 }
 159
 160 =head2 ObjectType
 161
 162 Returns the current value of ObjectType.
 163 (In the database, ObjectType is stored as varchar(64).)
 164
 165
 166
 167 =head2 SetObjectType VALUE
 168
 169
 170 Set ObjectType to VALUE.
 171 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 172 (In the database, ObjectType will be stored as a varchar(64).)
 173
 174
 175 =cut
 176
 177
 178 =head2 ObjectId
 179
 180 Returns the current value of ObjectId.
 181 (In the database, ObjectId is stored as int(11).)
 182
 183
 184
 185 =head2 SetObjectId VALUE
 186
 187
 188 Set ObjectId to VALUE.
 189 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 190 (In the database, ObjectId will be stored as a int(11).)
 191
 192
 193 =cut
 194
 195
 196
 197 sub _CoreAccessible {
 198     {
 199
 200         id =>
 201                 {read => 1, type => 'int(11)', default => ''},
 202         Topic =>
 203                 {read => 1, write => 1, type => 'int(11)', default => '0'},
 204         ObjectType =>
 205                 {read => 1, write => 1, type => 'varchar(64)', default => ''},
 206         ObjectId =>
 207                 {read => 1, write => 1, type => 'int(11)', default => '0'},
 208
 209  }
 210 };
 211
 212 RT::Base->_ImportOverlays();
 213
 214 1;