/usr/share/doc/rt4-doc-html/RT/Scrip.html is in rt4-doc-html 4.0.19-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 | <ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#METHODS">METHODS</a>
<ul>
<li><a href="#Create">Create</a></li>
<li><a href="#Delete">Delete</a></li>
<li><a href="#QueueObj">QueueObj</a></li>
<li><a href="#ActionObj">ActionObj</a></li>
<li><a href="#ConditionObj">ConditionObj</a></li>
<li><a href="#LoadModules">LoadModules</a></li>
<li><a href="#TemplateObj">TemplateObj</a></li>
<li><a href="#Apply-TicketObj-undef-TransactionObj-undef">Apply { TicketObj => undef, TransactionObj => undef}</a></li>
<li><a href="#IsApplicable">IsApplicable</a></li>
<li><a href="#Prepare">Prepare</a></li>
<li><a href="#Commit">Commit</a></li>
<li><a href="#CurrentUserHasRight">CurrentUserHasRight</a></li>
<li><a href="#HasRight">HasRight</a></li>
<li><a href="#CompileCheck">CompileCheck</a></li>
<li><a href="#SetScripAction">SetScripAction</a></li>
<li><a href="#SetScripCondition">SetScripCondition</a></li>
<li><a href="#SetTemplate">SetTemplate</a></li>
<li><a href="#id">id</a></li>
<li><a href="#Description">Description</a></li>
<li><a href="#SetDescription-VALUE">SetDescription VALUE</a></li>
<li><a href="#ScripCondition">ScripCondition</a></li>
<li><a href="#SetScripCondition-VALUE">SetScripCondition VALUE</a></li>
<li><a href="#ScripConditionObj">ScripConditionObj</a></li>
<li><a href="#ScripAction">ScripAction</a></li>
<li><a href="#SetScripAction-VALUE">SetScripAction VALUE</a></li>
<li><a href="#ScripActionObj">ScripActionObj</a></li>
<li><a href="#ConditionRules">ConditionRules</a></li>
<li><a href="#SetConditionRules-VALUE">SetConditionRules VALUE</a></li>
<li><a href="#ActionRules">ActionRules</a></li>
<li><a href="#SetActionRules-VALUE">SetActionRules VALUE</a></li>
<li><a href="#CustomIsApplicableCode">CustomIsApplicableCode</a></li>
<li><a href="#SetCustomIsApplicableCode-VALUE">SetCustomIsApplicableCode VALUE</a></li>
<li><a href="#CustomPrepareCode">CustomPrepareCode</a></li>
<li><a href="#SetCustomPrepareCode-VALUE">SetCustomPrepareCode VALUE</a></li>
<li><a href="#CustomCommitCode">CustomCommitCode</a></li>
<li><a href="#SetCustomCommitCode-VALUE">SetCustomCommitCode VALUE</a></li>
<li><a href="#Stage">Stage</a></li>
<li><a href="#SetStage-VALUE">SetStage VALUE</a></li>
<li><a href="#Queue">Queue</a></li>
<li><a href="#SetQueue-VALUE">SetQueue VALUE</a></li>
<li><a href="#Template">Template</a></li>
<li><a href="#SetTemplate-VALUE">SetTemplate VALUE</a></li>
<li><a href="#Creator">Creator</a></li>
<li><a href="#Created">Created</a></li>
<li><a href="#LastUpdatedBy">LastUpdatedBy</a></li>
<li><a href="#LastUpdated">LastUpdated</a></li>
</ul>
</li>
</ul>
<h1 id="NAME"><a href="#___top">NAME</a></h1>
<pre><code> RT::Scrip - an RT Scrip object</code></pre>
<h1 id="SYNOPSIS"><a href="#___top">SYNOPSIS</a></h1>
<pre><code> use RT::Scrip;</code></pre>
<h1 id="DESCRIPTION"><a href="#___top">DESCRIPTION</a></h1>
<h1 id="METHODS"><a href="#___top">METHODS</a></h1>
<h2 id="Create"><a href="#___top">Create</a></h2>
<p>Creates a new entry in the Scrips table. Takes a paramhash with:</p>
<pre><code> Queue => 0,
Description => undef,
Template => undef,
ScripAction => undef,
ScripCondition => undef,
CustomPrepareCode => undef,
CustomCommitCode => undef,
CustomIsApplicableCode => undef,</code></pre>
<p>Returns (retval, msg); retval is 0 for failure or scrip id. msg is a textual description of what happened.</p>
<h2 id="Delete"><a href="#___top">Delete</a></h2>
<p>Delete this object</p>
<h2 id="QueueObj"><a href="#___top">QueueObj</a></h2>
<p>Retuns an RT::Queue object with this Scrip's queue</p>
<h2 id="ActionObj"><a href="#___top">ActionObj</a></h2>
<p>Retuns an RT::Action object with this Scrip's Action</p>
<h2 id="ConditionObj"><a href="#___top">ConditionObj</a></h2>
<p>Retuns an <a href="../../../rt/latest/RT/ScripCondition.html">RT::ScripCondition</a> object with this Scrip's IsApplicable</p>
<h2 id="LoadModules"><a href="#___top">LoadModules</a></h2>
<p>Loads scrip's condition and action modules.</p>
<h2 id="TemplateObj"><a href="#___top">TemplateObj</a></h2>
<p>Retuns an RT::Template object with this Scrip's Template</p>
<h2 id="Apply-TicketObj-undef-TransactionObj-undef"><a href="#___top">Apply { TicketObj => undef, TransactionObj => undef}</a></h2>
<p>This method instantiates the ScripCondition and ScripAction objects for a single execution of this scrip. it then calls the IsApplicable method of the ScripCondition. If that succeeds, it calls the Prepare method of the ScripAction. If that succeeds, it calls the Commit method of the ScripAction.</p>
<p>Usually, the ticket and transaction objects passed to this method should be loaded by the SuperUser role</p>
<h2 id="IsApplicable"><a href="#___top">IsApplicable</a></h2>
<p>Calls the Condition object's IsApplicable method</p>
<p>Upon success, returns the applicable Transaction object. Otherwise, undef is returned.</p>
<p>If the Scrip is in the TransactionCreate Stage (the usual case), only test the associated Transaction object to see if it is applicable.</p>
<p>For Scrips in the TransactionBatch Stage, test all Transaction objects created during the Ticket object's lifetime, and returns the first one that is applicable.</p>
<h2 id="Prepare"><a href="#___top">Prepare</a></h2>
<p>Calls the action object's prepare method</p>
<h2 id="Commit"><a href="#___top">Commit</a></h2>
<p>Calls the action object's commit method</p>
<h2 id="CurrentUserHasRight"><a href="#___top">CurrentUserHasRight</a></h2>
<p>Helper menthod for HasRight. Presets Principal to CurrentUser then calls HasRight.</p>
<h2 id="HasRight"><a href="#___top">HasRight</a></h2>
<p>Takes a param-hash consisting of "Right" and "Principal" Principal is an RT::User object or an RT::CurrentUser object. "Right" is a textual Right string that applies to Scrips.</p>
<h2 id="CompileCheck"><a href="#___top">CompileCheck</a></h2>
<p>This routine compile-checks the custom prepare, commit, and is-applicable code to see if they are syntactically valid Perl. We eval them in a codeblock to avoid actually executing the code.</p>
<p>If one of the fields has a compile error, only the first is reported.</p>
<p>Returns an (ok, message) pair.</p>
<h2 id="SetScripAction"><a href="#___top">SetScripAction</a></h2>
<h2 id="SetScripCondition"><a href="#___top">SetScripCondition</a></h2>
<h2 id="SetTemplate"><a href="#___top">SetTemplate</a></h2>
<h2 id="id"><a href="#___top">id</a></h2>
<p>Returns the current value of id. (In the database, id is stored as int(11).)</p>
<h2 id="Description"><a href="#___top">Description</a></h2>
<p>Returns the current value of Description. (In the database, Description is stored as varchar(255).)</p>
<h2 id="SetDescription-VALUE"><a href="#___top">SetDescription VALUE</a></h2>
<p>Set Description to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Description will be stored as a varchar(255).)</p>
<h2 id="ScripCondition"><a href="#___top">ScripCondition</a></h2>
<p>Returns the current value of ScripCondition. (In the database, ScripCondition is stored as int(11).)</p>
<h2 id="SetScripCondition-VALUE"><a href="#___top">SetScripCondition VALUE</a></h2>
<p>Set ScripCondition to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, ScripCondition will be stored as a int(11).)</p>
<h2 id="ScripConditionObj"><a href="#___top">ScripConditionObj</a></h2>
<p>Returns the ScripCondition Object which has the id returned by ScripCondition</p>
<h2 id="ScripAction"><a href="#___top">ScripAction</a></h2>
<p>Returns the current value of ScripAction. (In the database, ScripAction is stored as int(11).)</p>
<h2 id="SetScripAction-VALUE"><a href="#___top">SetScripAction VALUE</a></h2>
<p>Set ScripAction to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, ScripAction will be stored as a int(11).)</p>
<h2 id="ScripActionObj"><a href="#___top">ScripActionObj</a></h2>
<p>Returns the ScripAction Object which has the id returned by ScripAction</p>
<h2 id="ConditionRules"><a href="#___top">ConditionRules</a></h2>
<p>Returns the current value of ConditionRules. (In the database, ConditionRules is stored as text.)</p>
<h2 id="SetConditionRules-VALUE"><a href="#___top">SetConditionRules VALUE</a></h2>
<p>Set ConditionRules to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, ConditionRules will be stored as a text.)</p>
<h2 id="ActionRules"><a href="#___top">ActionRules</a></h2>
<p>Returns the current value of ActionRules. (In the database, ActionRules is stored as text.)</p>
<h2 id="SetActionRules-VALUE"><a href="#___top">SetActionRules VALUE</a></h2>
<p>Set ActionRules to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, ActionRules will be stored as a text.)</p>
<h2 id="CustomIsApplicableCode"><a href="#___top">CustomIsApplicableCode</a></h2>
<p>Returns the current value of CustomIsApplicableCode. (In the database, CustomIsApplicableCode is stored as text.)</p>
<h2 id="SetCustomIsApplicableCode-VALUE"><a href="#___top">SetCustomIsApplicableCode VALUE</a></h2>
<p>Set CustomIsApplicableCode to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, CustomIsApplicableCode will be stored as a text.)</p>
<h2 id="CustomPrepareCode"><a href="#___top">CustomPrepareCode</a></h2>
<p>Returns the current value of CustomPrepareCode. (In the database, CustomPrepareCode is stored as text.)</p>
<h2 id="SetCustomPrepareCode-VALUE"><a href="#___top">SetCustomPrepareCode VALUE</a></h2>
<p>Set CustomPrepareCode to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, CustomPrepareCode will be stored as a text.)</p>
<h2 id="CustomCommitCode"><a href="#___top">CustomCommitCode</a></h2>
<p>Returns the current value of CustomCommitCode. (In the database, CustomCommitCode is stored as text.)</p>
<h2 id="SetCustomCommitCode-VALUE"><a href="#___top">SetCustomCommitCode VALUE</a></h2>
<p>Set CustomCommitCode to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, CustomCommitCode will be stored as a text.)</p>
<h2 id="Stage"><a href="#___top">Stage</a></h2>
<p>Returns the current value of Stage. (In the database, Stage is stored as varchar(32).)</p>
<h2 id="SetStage-VALUE"><a href="#___top">SetStage VALUE</a></h2>
<p>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).)</p>
<h2 id="Queue"><a href="#___top">Queue</a></h2>
<p>Returns the current value of Queue. (In the database, Queue is stored as int(11).)</p>
<h2 id="SetQueue-VALUE"><a href="#___top">SetQueue VALUE</a></h2>
<p>Set Queue to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Queue will be stored as a int(11).)</p>
<h2 id="Template"><a href="#___top">Template</a></h2>
<p>Returns the current value of Template. (In the database, Template is stored as int(11).)</p>
<h2 id="SetTemplate-VALUE"><a href="#___top">SetTemplate VALUE</a></h2>
<p>Set Template to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Template will be stored as a int(11).)</p>
<h2 id="Creator"><a href="#___top">Creator</a></h2>
<p>Returns the current value of Creator. (In the database, Creator is stored as int(11).)</p>
<h2 id="Created"><a href="#___top">Created</a></h2>
<p>Returns the current value of Created. (In the database, Created is stored as datetime.)</p>
<h2 id="LastUpdatedBy"><a href="#___top">LastUpdatedBy</a></h2>
<p>Returns the current value of LastUpdatedBy. (In the database, LastUpdatedBy is stored as int(11).)</p>
<h2 id="LastUpdated"><a href="#___top">LastUpdated</a></h2>
<p>Returns the current value of LastUpdated. (In the database, LastUpdated is stored as datetime.)</p>
<a href="./../">← Back to index</a>
|