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