rt/lib/RT/Shredder/Constants.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2016 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 package RT::Shredder::Constants;
  50
  51 use strict;
  52 use warnings;
  53
  54 =head1 NAME
  55
  56 RT::Shredder::Constants -  RT::Shredder constants that is used to mark state of RT objects.
  57
  58 =head1 DESCRIPTION
  59
  60 This module contains two group of bit constants.
  61 First group is group of flags which are used to clarify dependecies between objects, and
  62 second group is states of RT objects in Shredder cache.
  63
  64 =head1 FLAGS
  65
  66 =head2 DEPENDS_ON
  67
  68 Targets that has such dependency flag set should be wiped out with base object.
  69
  70 =head2 WIPE_AFTER
  71
  72 If dependency has such flag then target object would be wiped only
  73 after base object. You should mark dependencies with this flag
  74 if two objects depends on each other, for example Group and Principal
  75 have such relationship, this mean Group depends on Principal record and
  76 that Principal record depends on the same Group record. Other examples:
  77 User and Principal, User and its ACL equivalence group.
  78
  79 =head2 VARIABLE
  80
  81 This flag is used to mark dependencies that can be resolved with changing
  82 value in target object. For example ticket can be created by user we can
  83 change this reference when we delete user.
  84
  85 =cut
  86
  87 use constant {
  88     DEPENDS_ON => 0x001,
  89     WIPE_AFTER => 0x002,
  90     VARIABLE   => 0x004,
  91 };
  92
  93 =head1 STATES
  94
  95 =head2 ON_STACK
  96
  97 Default state of object in Shredder cache that means that object is
  98 loaded and placed into cache.
  99
 100 =head2 WIPED
 101
 102 Objects with this state are not exist any more in DB, but perl
 103 object is still in memory. This state is used to be shure that
 104 delete query is called once.
 105
 106 =cut
 107
 108 use constant {
 109     ON_STACK  => 0x000,
 110     IN_WIPING => 0x010,
 111     WIPED     => 0x020,
 112 };
 113
 114 1;