blob: ba9729fb1597a8106f806292810ae0875b35217a (
plain)
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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>
Bugzilla::Whine::Query</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::Whine::Query</h1>
<div class='indexgroup'>
<ul class='indexList indexList1'>
<li class='indexItem indexItem1'><a href='#NAME'>NAME</a>
<li class='indexItem indexItem1'><a href='#SYNOPSIS'>SYNOPSIS</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='#Constructors'>Constructors</a>
<li class='indexItem indexItem2'><a href='#Accessors'>Accessors</a>
</ul>
</ul>
</div>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="NAME"
>NAME</a></h1>
<p>Bugzilla::Whine::Query - A query object used by <a href="../../Bugzilla/Whine.html" class="podlinkpod"
>Bugzilla::Whine</a>.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="SYNOPSIS"
>SYNOPSIS</a></h1>
<pre class="code"> use Bugzilla::Whine::Query;
my $query = new Bugzilla::Whine::Query($id);
my $event_id = $query->eventid;
my $id = $query->id;
my $query_name = $query->name;
my $sortkey = $query->sortkey;
my $one_email_per_bug = $query->one_email_per_bug;
my $title = $query->title;</pre>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="DESCRIPTION"
>DESCRIPTION</a></h1>
<p>This module exists to represent a query for a <a href="../../Bugzilla/Whine/Event.html" class="podlinkpod"
>Bugzilla::Whine::Event</a>. Each event, which are groups of schedules and queries based on how the user configured the event, may have zero or more queries associated with it. Additionally, the queries are selected from the user's saved searches, or <a href="../../Bugzilla/Search/Saved.html" class="podlinkpod"
>Bugzilla::Search::Saved</a> object with a matching <code class="code">name</code> attribute for the user.</p>
<p>This is an implementation of <a href="../../Bugzilla/Object.html" class="podlinkpod"
>Bugzilla::Object</a>, and so has all the same methods available as <a href="../../Bugzilla/Object.html" class="podlinkpod"
>Bugzilla::Object</a>, in addition to what is documented below.</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="Constructors"
>Constructors</a></h2>
<dl>
<dt><a name="new"
><code class="code">new</code></a></dt>
<dd>
<p>Does not accept a bare <code class="code">name</code> argument. Instead, accepts only an id.</p>
<p>See also: <a href="../../Bugzilla/Object.html#new" class="podlinkpod"
>"new" in Bugzilla::Object</a>.</p>
</dd>
</dl>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="Accessors"
>Accessors</a></h2>
<p>These return data about the object, without modifying the object.</p>
<dl>
<dt><a name="event_id"
><code class="code">event_id</code></a></dt>
<dd>
<p>The <a href="../../Bugzilla/Whine/Event.html" class="podlinkpod"
>Bugzilla::Whine::Event</a> object id for this object.</p>
<dt><a name="name"
><code class="code">name</code></a></dt>
<dd>
<p>The <a href="../../Bugzilla/Search/Saved.html" class="podlinkpod"
>Bugzilla::Search::Saved</a> query object name for this object.</p>
<dt><a name="sortkey"
><code class="code">sortkey</code></a></dt>
<dd>
<p>The relational sorting key as compared with other <a href="../../Bugzilla/Whine/Query.html" class="podlinkpod"
>Bugzilla::Whine::Query</a> objects.</p>
<dt><a name="one_email_per_bug"
><code class="code">one_email_per_bug</code></a></dt>
<dd>
<p>Returns a numeric 1(<code class="code">true</code>) or 0(<code class="code">false</code>) to represent whether this <a href="../../Bugzilla/Whine/Query.html" class="podlinkpod"
>Bugzilla::Whine::Query</a> object is supposed to be mailed as a list of bugs or one email per bug.</p>
<dt><a name="title"
><code class="code">title</code></a></dt>
<dd>
<p>The title of this object as it appears in the user forms and emails.</p>
</dd>
</dl>
<p class="backlinkbottom"><b><a name="___bottom" href="../../index.html" title="All Documents"><<</a></b></p>
<!-- end doc -->
</body></html>
|
GitWeb