J2Bugzilla-API/src/main/java/com/j2bugzilla/api/SearchBy.java at 6784ca870879d60a191a1505f59248cf832d5686 · Thorn1089/J2Bugzilla-API · GitHub

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
package com.j2bugzilla.api;

/**
 * The {@code SearchBy} enum provides a type-safe listing of all available search parameters in a Bugzilla
 * installation.
 *
 * @author Tom
 */
public enum SearchBy {

	/**
	 * The email of the assignee
	 */
	OWNER("assigned_to"),

	/**
	 * The email of the reporting user
	 */
	REPORTER("reporter"),

	/**
	 * The {@link jbugz.base.Bug.Status} field value
	 */
	STATUS("status"),

	/**
	 * The resolution field, if the bug's status is closed. You can search
	 * for all open bugs by searching for a blank resolution.
	 */
	RESOLUTION("resolution"),

	/**
	 * The {@link jbugz.base.Bug.Priority} field value
	 */
	PRIORITY("priority"),

	/**
	 * The product affected by this bug
	 */
	PRODUCT("product"),

	/**
	 * The component affected by this bug
	 */
	COMPONENT("component"),

	/**
	 * The operating system affected by this bug
	 */
	OPERATING_SYSTEM("op_sys"),

	/**
	 * The hardware affected by this bug
	 */
	PLATFORM("platform"),

	/**
	 * The initial summary comment
	 */
	SUMMARY("summary"),

	/**
	 * The version affected by this bug
	 */
	VERSION("version"),

	/**
	 * The unique alias for a bug
	 */
	ALIAS("alias"),

	/**
	 * The maximum number of bugs to return.
	 */
	LIMIT("limit"),

	/**
	 * An offset into bugs returned by search.
	 */
	OFFSET("offset");

	private final String name;
	/**
	 * Creates a new {@link SearchBy} with the
	 * designated name
	 * @param name The name Bugzilla expects for this search limiter
	 */
	SearchBy(String name) {
		this.name = name;
	}
	/**
	 * Get the name Bugzilla expects for this search limiter
	 * @return A <code>String</code> representing the search limiter
	 */
	public String getName() {
		return this.name;
	}
}