rt/lib/RT/Shredder/Constants.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2011 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 base qw(Exporter);
  52
  53 =head1 NAME
  54
  55 RT::Shredder::Constants -  RT::Shredder constants that is used to mark state of RT objects.
  56
  57 =head1 DESCRIPTION
  58
  59 This module exports two group of bit constants.
  60 First group is group of flags which are used to clarify dependecies between objects, and
  61 second group is states of RT objects in Shredder cache.
  62
  63 =head1 FLAGS
  64
  65 =head2 DEPENDS_ON
  66
  67 Targets that has such dependency flag set should be wiped out with base object.
  68
  69 =head2 WIPE_AFTER
  70
  71 If dependency has such flag then target object would be wiped only
  72 after base object. You should mark dependencies with this flag
  73 if two objects depends on each other, for example Group and Principal
  74 have such relationship, this mean Group depends on Principal record and
  75 that Principal record depends on the same Group record. Other examples:
  76 User and Principal, User and its ACL equivalence group.
  77
  78 =head2 VARIABLE
  79
  80 This flag is used to mark dependencies that can be resolved with changing
  81 value in target object. For example ticket can be created by user we can
  82 change this reference when we delete user.
  83
  84 =head2 RELATES
  85
  86 This flag is used to validate relationships integrity. Base object
  87 is valid only when all target objects which are marked with this flags
  88 exist.
  89
  90 =cut
  91
  92 use constant {
  93     DEPENDS_ON    => 0x000001,
  94     WIPE_AFTER    => 0x000010,
  95     RELATES        => 0x000100,
  96     VARIABLE    => 0x001000,
  97 };
  98
  99 =head1 STATES
 100
 101 =head2 ON_STACK
 102
 103 Default state of object in Shredder cache that means that object is
 104 loaded and placed into cache.
 105
 106 =head2 WIPED
 107
 108 Objects with this state are not exist any more in DB, but perl
 109 object is still in memory. This state is used to be shure that
 110 delete query is called once.
 111
 112 =head2 VALID
 113
 114 Object is marked with this state only when its relationships
 115 are valid.
 116
 117 =head2 INVALID
 118
 119 =cut
 120
 121 use constant {
 122     ON_STACK    => 0x00000,
 123     IN_WIPING    => 0x00001,
 124     WIPED        => 0x00010,
 125     VALID        => 0x00100,
 126     INVALID        => 0x01000,
 127 };
 128
 129 our @EXPORT = qw(
 130         DEPENDS_ON
 131         WIPE_AFTER
 132         RELATES
 133         VARIABLE
 134         ON_STACK
 135         IN_WIPING
 136         WIPED
 137         VALID
 138         INVALID
 139         );
 140
 141 1;