<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>
Bugzilla::Field::ChoiceInterface</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" title="style" type="text/css" href="../.././../../../../style.css" media="all" >
</head>
<body id="pod">
<p class="backlinktop"><b><a name="___top" href="../../index.html" accesskey="1" title="All Documents"><<</a></b></p>
<h1>Bugzilla::Field::ChoiceInterface</h1>
<div class='indexgroup'>
<ul class='indexList indexList1'>
<li class='indexItem indexItem1'><a href='#NAME'>NAME</a>
<li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a>
<li class='indexItem indexItem1'><a href='#METHODS'>METHODS</a>
<ul class='indexList indexList2'>
<li class='indexItem indexItem2'><a href='#Accessors'>Accessors</a>
</ul>
<li class='indexItem indexItem1'><a href='#Methods_in_need_of_POD'>Methods in need of POD</a>
</ul>
</div>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="NAME"
>NAME</a></h1>
<p>Bugzilla::Field::ChoiceInterface - Makes an object act like a Bugzilla::Field::Choice.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="DESCRIPTION"
>DESCRIPTION</a></h1>
<p>This is an "interface",
in the Java sense (sometimes called a "Role" or a "Mixin" in other languages).
<a href="../../Bugzilla/Field/Choice.html" class="podlinkpod"
>Bugzilla::Field::Choice</a> is the primary implementor of this interface,
but other classes also implement it if they want to "act like" <a href="../../Bugzilla/Field/Choice.html" class="podlinkpod"
>Bugzilla::Field::Choice</a>.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="METHODS"
>METHODS</a></h1>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="Accessors"
>Accessors</a></h2>
<p>These are in addition to the standard <a href="../../Bugzilla/Object.html" class="podlinkpod"
>Bugzilla::Object</a> accessors.</p>
<dl>
<dt><a name="sortkey"
><code class="code">sortkey</code></a></dt>
<dd>
<p>The key that determines the sort order of this item.</p>
<dt><a name="field"
><code class="code">field</code></a></dt>
<dd>
<p>The <a href="../../Bugzilla/Field.html" class="podlinkpod"
>Bugzilla::Field</a> object that this field value belongs to.</p>
<dt><a name="is_active"
><code class="code">is_active</code></a></dt>
<dd>
<p>Whether or not this value should appear as an option on bugs that do not already have it set as the current value.</p>
<dt><a name="is_static"
><code class="code">is_static</code></a></dt>
<dd>
<p><code class="code">0</code> if this field value can be renamed or deleted,
<code class="code">1</code> otherwise.</p>
<dt><a name="is_default"
><code class="code">is_default</code></a></dt>
<dd>
<p><code class="code">1</code> if this is the default value for this field,
<code class="code">0</code> otherwise.</p>
<dt><a name="bug_count"
><code class="code">bug_count</code></a></dt>
<dd>
<p>An integer count of the number of bugs that have this value set.</p>
<dt><a name="controls_visibility_of_fields"
><code class="code">controls_visibility_of_fields</code></a></dt>
<dd>
<p>Returns an arrayref of <a href="../../Bugzilla/Field.html" class="podlinkpod"
>Bugzilla::Field</a> objects,
representing any fields whose visibility are controlled by this field value.</p>
<dt><a name="controlled_values"
><code class="code">controlled_values</code></a></dt>
<dd>
<p>Tells you which values in <b>other</b> fields appear (become visible) when this value is set in its field.</p>
<p>Returns a hashref of arrayrefs.
The hash keys are the names of fields,
and the values are arrays of objects that implement <code class="code">Bugzilla::Field::ChoiceInterface</code>,
representing values that this value controls the visibility of,
for that field.</p>
<dt><a name="visibility_value"
><code class="code">visibility_value</code></a></dt>
<dd>
<p>Returns an object that implements <code class="code">Bugzilla::Field::ChoiceInterface</code>,
which represents the value that needs to be set in order for this value to appear in the UI.</p>
<dt><a name="is_visible_on_bug"
><code class="code">is_visible_on_bug</code></a></dt>
<dd>
<p>Returns <code class="code">1</code> if,
according to the settings of <code class="code">is_active</code> and <code class="code">visibility_value</code>,
this value should be displayed as an option when viewing a bug.
Returns <code class="code">0</code> otherwise.</p>
<p>Takes a single argument,
a <a href="../../Bugzilla/Bug.html" class="podlinkpod"
>Bugzilla::Bug</a> object or a hash with similar fields to a <a href="../../Bugzilla/Bug.html" class="podlinkpod"
>Bugzilla::Bug</a> object.</p>
<dt><a name="is_set_on_bug"
><code class="code">is_set_on_bug</code></a></dt>
<dd>
<p>Returns <code class="code">1</code> if this value is the current value set for its field on the passed-in <a href="../../Bugzilla/Bug.html" class="podlinkpod"
>Bugzilla::Bug</a> object (or a hash that looks like a <a href="../../Bugzilla/Bug.html" class="podlinkpod"
>Bugzilla::Bug</a>).
For multi-valued fields,
we return <code class="code">1</code> if <i>any</i> of the currently selected values are this value.</p>
<p>Returns <code class="code">0</code> otherwise.</p>
</dd>
</dl>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="Methods_in_need_of_POD"
><b>Methods in need of POD</b></a></h1>
<dl>
<dt><a name="FIELD_NAME"
>FIELD_NAME</a></dt>
<dd>
<dt><a name="controlled_values_array"
>controlled_values_array</a></dt>
</dl>
<p class="backlinkbottom"><b><a name="___bottom" href="../../index.html" title="All Documents"><<</a></b></p>
<!-- end doc -->
</body></html>
