rt4-doc-html 4.4.2-2 / usr / share / doc / rt4-doc-html / RT / CustomRole.html

<ul id="index">
  <li><a href="#NAME">NAME</a></li>
  <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
  <li><a href="#METHODS">METHODS</a>
    <ul>
      <li><a href="#Table">Table</a></li>
      <li><a href="#Create-PARAMHASH">Create PARAMHASH</a></li>
      <li><a href="#Load-ID-NAME">Load ID/NAME</a></li>
      <li><a href="#ValidateName-NAME">ValidateName NAME</a></li>
      <li><a href="#Delete">Delete</a></li>
      <li><a href="#IsAdded">IsAdded</a></li>
      <li><a href="#IsAddedToAny">IsAddedToAny</a></li>
      <li><a href="#AddedTo">AddedTo</a></li>
      <li><a href="#NotAddedTo">NotAddedTo</a></li>
      <li><a href="#AddToObject">AddToObject</a></li>
      <li><a href="#RemoveFromObject">RemoveFromObject</a></li>
      <li><a href="#SingleValue">SingleValue</a></li>
      <li><a href="#UnlimitedValues">UnlimitedValues</a></li>
      <li><a href="#GroupType">GroupType</a></li>
      <li><a href="#id">id</a></li>
      <li><a href="#Name">Name</a></li>
      <li><a href="#SetName-VALUE">SetName VALUE</a></li>
      <li><a href="#Description">Description</a></li>
      <li><a href="#SetDescription-VALUE">SetDescription VALUE</a></li>
      <li><a href="#MaxValues">MaxValues</a></li>
      <li><a href="#SetMaxValues-VALUE">SetMaxValues VALUE</a></li>
      <li><a href="#EntryHint">EntryHint</a></li>
      <li><a href="#SetEntryHint-VALUE">SetEntryHint 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>
      <li><a href="#Disabled">Disabled</a></li>
      <li><a href="#SetDisabled-VALUE">SetDisabled VALUE</a></li>
    </ul>
  </li>
</ul>

<h1 id="NAME"><a href="#___top">NAME</a></h1>

<p>RT::CustomRole - user-defined role groups</p>

<h1 id="DESCRIPTION"><a href="#___top">DESCRIPTION</a></h1>

<h1 id="METHODS"><a href="#___top">METHODS</a></h1>

<h2 id="Table"><a href="#___top">Table</a></h2>

<p>Returns table name for records of this class</p>

<h2 id="Create-PARAMHASH"><a href="#___top">Create PARAMHASH</a></h2>

<p>Create takes a hash of values and creates a row in the database:</p>

<pre><code>  varchar(200) &#39;Name&#39;.
  varchar(255) &#39;Description&#39;.
  int(11) &#39;MaxValues&#39;.
  varchar(255) &#39;EntryHint&#39;.
  smallint(6) &#39;Disabled&#39;.</code></pre>

<h2 id="Load-ID-NAME"><a href="#___top">Load ID/NAME</a></h2>

<p>Load a custom role. If the value handed in is an integer, load by ID. Otherwise, load by name.</p>

<h2 id="ValidateName-NAME"><a href="#___top">ValidateName NAME</a></h2>

<p>Takes a custom role name. Returns true if it&#39;s an ok name for a new custom role. Returns undef if there&#39;s already a role by that name.</p>

<h2 id="Delete"><a href="#___top">Delete</a></h2>

<p>Delete this object. You should Disable instead.</p>

<h2 id="IsAdded"><a href="#___top">IsAdded</a></h2>

<p>Takes an object id and returns a boolean indicating whether the custom role applies to that object</p>

<h2 id="IsAddedToAny"><a href="#___top">IsAddedToAny</a></h2>

<p>Returns a boolean of whether this custom role has been applied to any objects</p>

<h2 id="AddedTo"><a href="#___top">AddedTo</a></h2>

<p>Returns a collection of objects this custom role is applied to</p>

<h2 id="NotAddedTo"><a href="#___top">NotAddedTo</a></h2>

<p>Returns a collection of objects this custom role is not applied to</p>

<h2 id="AddToObject"><a href="#___top">AddToObject</a></h2>

<p>Adds (applies) this custom role to the provided queue (ObjectId).</p>

<p>Accepts a param hash of:</p>

<dl>

<dt id="ObjectId"><code>ObjectId</code></dt>
<dd>

<p>Queue name or id.</p>

</dd>
<dt id="SortOrder"><code>SortOrder</code></dt>
<dd>

<p>Number indicating the relative order of the custom role</p>

</dd>
</dl>

<p>Returns (val, message). If val is false, the message contains an error message.</p>

<h2 id="RemoveFromObject"><a href="#___top">RemoveFromObject</a></h2>

<p>Removes this custom role from the provided queue (ObjectId).</p>

<p>Accepts a param hash of:</p>

<dl>

<dt id="ObjectId1"><code>ObjectId</code></dt>
<dd>

<p>Queue name or id.</p>

</dd>
</dl>

<p>Returns (val, message). If val is false, the message contains an error message.</p>

<h2 id="SingleValue"><a href="#___top">SingleValue</a></h2>

<p>Returns true if this custom role accepts only a single member. Returns false if it accepts multiple members.</p>

<h2 id="UnlimitedValues"><a href="#___top">UnlimitedValues</a></h2>

<p>Returns true if this custom role accepts multiple members. Returns false if it accepts only a single member.</p>

<h2 id="GroupType"><a href="#___top">GroupType</a></h2>

<p>The <code>Name</code> that groups for this custom role will have.</p>

<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="Name"><a href="#___top">Name</a></h2>

<p>Returns the current value of Name. (In the database, Name is stored as varchar(200).)</p>

<h2 id="SetName-VALUE"><a href="#___top">SetName VALUE</a></h2>

<p>Set Name to VALUE. Returns (1, &#39;Status message&#39;) on success and (0, &#39;Error Message&#39;) on failure. (In the database, Name will be stored as a varchar(200).)</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, &#39;Status message&#39;) on success and (0, &#39;Error Message&#39;) on failure. (In the database, Description will be stored as a varchar(255).)</p>

<h2 id="MaxValues"><a href="#___top">MaxValues</a></h2>

<p>Returns the current value of MaxValues. (In the database, MaxValues is stored as int(11).)</p>

<h2 id="SetMaxValues-VALUE"><a href="#___top">SetMaxValues VALUE</a></h2>

<p>Set MaxValues to VALUE. Returns (1, &#39;Status message&#39;) on success and (0, &#39;Error Message&#39;) on failure. (In the database, MaxValues will be stored as a int(11).)</p>

<h2 id="EntryHint"><a href="#___top">EntryHint</a></h2>

<p>Returns the current value of EntryHint. (In the database, EntryHint is stored as varchar(255).)</p>

<h2 id="SetEntryHint-VALUE"><a href="#___top">SetEntryHint VALUE</a></h2>

<p>Set EntryHint to VALUE. Returns (1, &#39;Status message&#39;) on success and (0, &#39;Error Message&#39;) on failure. (In the database, EntryHint will be stored as a varchar(255).)</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>

<h2 id="Disabled"><a href="#___top">Disabled</a></h2>

<p>Returns the current value of Disabled. (In the database, Disabled is stored as smallint(6).)</p>

<h2 id="SetDisabled-VALUE"><a href="#___top">SetDisabled VALUE</a></h2>

<p>Set Disabled to VALUE. Returns (1, &#39;Status message&#39;) on success and (0, &#39;Error Message&#39;) on failure. (In the database, Disabled will be stored as a smallint(6).)</p>

<a href="./../">&larr; Back to index</a>