/usr/share/doc/rt4-doc-html/RT/SharedSetting.html is in rt4-doc-html 4.4.2-2.
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 | <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="#new">new</a></li>
<li><a href="#Load">Load</a></li>
<li><a href="#LoadById">LoadById</a></li>
<li><a href="#PostLoad">PostLoad</a></li>
<li><a href="#PostLoadValidate">PostLoadValidate</a></li>
<li><a href="#Save">Save</a></li>
<li><a href="#SaveAttribute">SaveAttribute</a></li>
<li><a href="#Update">Update</a></li>
<li><a href="#UpdateAttribute">UpdateAttribute</a></li>
<li><a href="#Delete">Delete</a></li>
<li><a href="#Name">Name</a></li>
<li><a href="#Id">Id</a></li>
<li><a href="#Privacy">Privacy</a></li>
<li><a href="#GetParameter">GetParameter</a></li>
<li><a href="#IsVisibleTo-Privacy">IsVisibleTo Privacy</a></li>
<li><a href="#ObjectsForLoading">ObjectsForLoading</a></li>
<li><a href="#ObjectsForCreating">ObjectsForCreating</a></li>
<li><a href="#ObjectsForModifying">ObjectsForModifying</a></li>
</ul>
</li>
</ul>
<h1 id="NAME"><a href="#___top">NAME</a></h1>
<p>RT::SharedSetting - an API for settings that belong to an RT::User or RT::Group</p>
<h1 id="SYNOPSIS"><a href="#___top">SYNOPSIS</a></h1>
<pre><code> use RT::SharedSetting;</code></pre>
<h1 id="DESCRIPTION"><a href="#___top">DESCRIPTION</a></h1>
<p>A RT::SharedSetting is an object that can belong to an <a href="../../../rt/latest/RT/User.html">RT::User</a> or an <RT::Group>. It consists of an ID, a name, and some arbitrary data.</p>
<h1 id="METHODS"><a href="#___top">METHODS</a></h1>
<h2 id="new"><a href="#___top">new</a></h2>
<p>Returns a new <a href="../../../rt/latest/RT/SharedSetting.html">RT::SharedSetting</a> object. Takes the current user, see also <a href="../RT/Base.html">RT::Base</a>.</p>
<h2 id="Load"><a href="#___top">Load</a></h2>
<p>Takes a privacy specification and a shared-setting ID. Loads the given object ID if it belongs to the stated user or group. Calls the <a href="#PostLoad">"PostLoad"</a> method on success for any further initialization. Returns a tuple of status and message, where status is true on success.</p>
<h2 id="LoadById"><a href="#___top">LoadById</a></h2>
<p>First loads up the <a href="../RT/Attribute.html">RT::Attribute</a> for this shared setting by ID, then calls <a href="#Load">"Load"</a> with the correct parameters. Returns a tuple of status and message, where status is true on success.</p>
<h2 id="PostLoad"><a href="#___top">PostLoad</a></h2>
<p>Called after a successful <a href="#Load">"Load"</a>.</p>
<h2 id="PostLoadValidate"><a href="#___top">PostLoadValidate</a></h2>
<p>Called just before returning success from <a href="#Load">"Load"</a>; may be used to validate that the record is correct. This method is expected to return a (ok, msg) pair.</p>
<h2 id="Save"><a href="#___top">Save</a></h2>
<p>Creates a new shared setting. Takes a privacy, a name, and any other arguments. Saves the given parameters to the appropriate user/group object, and loads the resulting object. Arguments are passed to the <a href="#SaveAttribute">"SaveAttribute"</a> method, which does the actual update. Returns a tuple of status and message, where status is true on success. Defaults are:</p>
<pre><code> Privacy: CurrentUser only
Name: "new (ObjectName)"</code></pre>
<h2 id="SaveAttribute"><a href="#___top">SaveAttribute</a></h2>
<p>An empty method for subclassing. Called from <a href="#Save">"Save"</a> method.</p>
<h2 id="Update"><a href="#___top">Update</a></h2>
<p>Updates the parameters of an existing shared setting. Any arguments are passed to the <a href="#UpdateAttribute">"UpdateAttribute"</a> method. Returns a tuple of status and message, where status is true on success.</p>
<h2 id="UpdateAttribute"><a href="#___top">UpdateAttribute</a></h2>
<p>An empty method for subclassing. Called from <a href="#Update">"Update"</a> method.</p>
<h2 id="Delete"><a href="#___top">Delete</a></h2>
<p>Deletes the existing shared setting. Returns a tuple of status and message, where status is true upon success.</p>
<h2 id="Name"><a href="#___top">Name</a></h2>
<p>Returns the name of this shared setting.</p>
<h2 id="Id"><a href="#___top">Id</a></h2>
<p>Returns the numerical ID of this shared setting.</p>
<h2 id="Privacy"><a href="#___top">Privacy</a></h2>
<p>Returns the principal object to whom this shared setting belongs, in a string "<class>-<id>", e.g. "RT::Group-16".</p>
<h2 id="GetParameter"><a href="#___top">GetParameter</a></h2>
<p>Returns the given named parameter of the setting.</p>
<h2 id="IsVisibleTo-Privacy"><a href="#___top">IsVisibleTo Privacy</a></h2>
<p>Returns true if the setting is visible to all principals of the given privacy. This does not deal with ACLs, this only looks at membership.</p>
<h2 id="ObjectsForLoading"><a href="#___top">ObjectsForLoading</a></h2>
<p>Returns a list of objects that can be used to load this shared setting. It is ACL checked.</p>
<h2 id="ObjectsForCreating"><a href="#___top">ObjectsForCreating</a></h2>
<p>Returns a list of objects that can be used to create this shared setting. It is ACL checked.</p>
<h2 id="ObjectsForModifying"><a href="#___top">ObjectsForModifying</a></h2>
<p>Returns a list of objects that can be used to modify this shared setting. It is ACL checked.</p>
<a href="./../">← Back to index</a>
|