X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=rt%2Flib%2FRT%2FObjectScrip.pm;fp=rt%2Flib%2FRT%2FObjectScrip.pm;h=d2a024a56f027425648b1e838f2b030d41ede6d5;hb=1c538bfabc2cd31f27067505f0c3d1a46cba6ef0;hp=0000000000000000000000000000000000000000;hpb=4f5619288413a185e9933088d9dd8c5afbc55dfa;p=freeside.git diff --git a/rt/lib/RT/ObjectScrip.pm b/rt/lib/RT/ObjectScrip.pm new file mode 100644 index 000000000..d2a024a56 --- /dev/null +++ b/rt/lib/RT/ObjectScrip.pm @@ -0,0 +1,277 @@ +# BEGIN BPS TAGGED BLOCK {{{ +# +# COPYRIGHT: +# +# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC +# +# +# (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; + +package RT::ObjectScrip; +use base 'RT::Record::AddAndSort'; + +use RT::Scrip; +use RT::ObjectScrips; +use Scalar::Util 'blessed'; + +=head1 NAME + +RT::ObjectScrip - record representing addition of a scrip to a queue + +=head1 DESCRIPTION + +This record is created if you want to add a scrip to a queue or globally. + +Inherits methods from L. + +For most operations it's better to use methods in L. + +=head1 METHODS + +=head2 Table + +Returns table name for records of this class. + +=cut + +sub Table {'ObjectScrips'} + +=head2 ObjectCollectionClass + +Returns class name of collection of records scrips can be added to. +Now it's only L, so 'RT::Queues' is returned. + +=cut + +sub ObjectCollectionClass {'RT::Queues'} + +=head2 ScripObj + +Returns the Scrip Object which has the id returned by Scrip + +=cut + +sub ScripObj { + my $self = shift; + my $id = shift || $self->Scrip; + my $obj = RT::Scrip->new( $self->CurrentUser ); + $obj->Load( $id ); + return $obj; +} + +=head2 Neighbors + +Stage splits scrips into neighborhoods. See L. + +=cut + +sub Neighbors { + my $self = shift; + my %args = @_; + + my $res = $self->CollectionClass->new( $self->CurrentUser ); + $res->Limit( FIELD => 'Stage', VALUE => $args{'Stage'} || $self->Stage ); + return $res; +} + +=head2 id + +Returns the current value of id. +(In the database, id is stored as int(11).) + + +=cut + + +=head2 Scrip + +Returns the current value of Scrip. +(In the database, Scrip is stored as int(11).) + +=head2 FriendlyStage + +Returns a localized human-readable version of the stage. + +=cut + +sub FriendlyStage { + my $self = shift; + my $scrip_class = blessed($self->ScripObj); + return $scrip_class->FriendlyStage($self->Stage); +} + +=head2 SetScrip VALUE + + +Set Scrip to VALUE. +Returns (1, 'Status message') on success and (0, 'Error Message') on failure. +(In the database, Scrip will be stored as a int(11).) + +=head2 Stage + +Returns the current value of Stage. +(In the database, Stage is stored as varchar(32).) + +=head2 SetStage VALUE + +Set Stage to VALUE. +Returns (1, 'Status message') on success and (0, 'Error Message') on failure. +(In the database, Stage will be stored as a varchar(32).) + +=head2 ObjectId + +Returns the current value of ObjectId. +(In the database, ObjectId is stored as int(11).) + + + +=head2 SetObjectId VALUE + + +Set ObjectId to VALUE. +Returns (1, 'Status message') on success and (0, 'Error Message') on failure. +(In the database, ObjectId will be stored as a int(11).) + + +=cut + + +=head2 SortOrder + +Returns the current value of SortOrder. +(In the database, SortOrder is stored as int(11).) + + + +=head2 SetSortOrder VALUE + + +Set SortOrder to VALUE. +Returns (1, 'Status message') on success and (0, 'Error Message') on failure. +(In the database, SortOrder will be stored as a int(11).) + + +=cut + + +=head2 Creator + +Returns the current value of Creator. +(In the database, Creator is stored as int(11).) + + +=cut + + +=head2 Created + +Returns the current value of Created. +(In the database, Created is stored as datetime.) + + +=cut + + +=head2 LastUpdatedBy + +Returns the current value of LastUpdatedBy. +(In the database, LastUpdatedBy is stored as int(11).) + + +=cut + + +=head2 LastUpdated + +Returns the current value of LastUpdated. +(In the database, LastUpdated is stored as datetime.) + + +=cut + + + +sub _CoreAccessible { + { + + id => + {read => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => ''}, + Scrip => + {read => 1, write => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => ''}, + Stage => + {read => 1, write => 1, sql_type => 12, length => 32, is_blob => 0, is_numeric => 0, type => 'varchar(32)', default => 'TransactionCreate'}, + ObjectId => + {read => 1, write => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => ''}, + SortOrder => + {read => 1, write => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'}, + Creator => + {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'}, + Created => + {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''}, + LastUpdatedBy => + {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'}, + LastUpdated => + {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''}, + + } +}; + +sub FindDependencies { + my $self = shift; + my ($walker, $deps) = @_; + + $self->SUPER::FindDependencies($walker, $deps); + + $deps->Add( out => $self->ScripObj ); + if ($self->ObjectId) { + my $obj = RT::Queue->new( $self->CurrentUser ); + $obj->Load( $self->ObjectId ); + $deps->Add( out => $obj ); + } +} + +RT::Base->_ImportOverlays(); + +1;