|
| 1 | +package org.gitlab4j.api.models; |
| 2 | + |
| 3 | +import org.gitlab4j.api.Constants.ProjectOrderBy; |
| 4 | +import org.gitlab4j.api.Constants.SortOrder; |
| 5 | +import org.gitlab4j.api.GitLabApiForm; |
| 6 | + |
| 7 | +/** |
| 8 | + * This class is used to filter Projects when getting lists of projects for a specified group. |
| 9 | + */ |
| 10 | +public class GroupProjectsFilter { |
| 11 | + |
| 12 | + private Boolean archived; |
| 13 | + private Visibility visibility; |
| 14 | + private ProjectOrderBy orderBy; |
| 15 | + private SortOrder sort; |
| 16 | + private String search; |
| 17 | + private Boolean simple; |
| 18 | + private Boolean owned; |
| 19 | + private Boolean starred; |
| 20 | + private Boolean withCustomAttributes; |
| 21 | + private Boolean withIssuesEnabled; |
| 22 | + private Boolean withMergeRequestsEnabled; |
| 23 | + |
| 24 | + /** |
| 25 | + * Limit by archived status. |
| 26 | + * |
| 27 | + * @param archived if true will only return archived projects |
| 28 | + * @return the reference to this ProjectFilter instance |
| 29 | + */ |
| 30 | + public GroupProjectsFilter withArchived(Boolean archived) { |
| 31 | + this.archived = archived; |
| 32 | + return (this); |
| 33 | + } |
| 34 | + |
| 35 | + /** |
| 36 | + * Limit by visibility public, internal, or private. |
| 37 | + * |
| 38 | + * @param visibility the visibility to match |
| 39 | + * @return the reference to this ProjectFilter instance |
| 40 | + */ |
| 41 | + public GroupProjectsFilter withVisibility(Visibility visibility) { |
| 42 | + this.visibility = visibility; |
| 43 | + return (this); |
| 44 | + } |
| 45 | + |
| 46 | + /** |
| 47 | + * Return projects ordered by id, name, path, created_at, updated_at, or last_activity_at fields. Default is created_at. |
| 48 | + * |
| 49 | + * @param orderBy specifies what field to order by |
| 50 | + * @return the reference to this ProjectFilter instance |
| 51 | + */ |
| 52 | + public GroupProjectsFilter withOrderBy(ProjectOrderBy orderBy) { |
| 53 | + this.orderBy = orderBy; |
| 54 | + return (this); |
| 55 | + } |
| 56 | + |
| 57 | + /** |
| 58 | + * Return projects sorted in asc or desc order. Default is desc. |
| 59 | + * |
| 60 | + * @param sort sort direction, ASC or DESC |
| 61 | + * @return the reference to this ProjectFilter instance |
| 62 | + */ |
| 63 | + public GroupProjectsFilter withSortOder(SortOrder sort) { |
| 64 | + this.sort = sort; |
| 65 | + return (this); |
| 66 | + } |
| 67 | + |
| 68 | + /** |
| 69 | + * Return list of projects matching the search criteria. |
| 70 | + * |
| 71 | + * @param search the search criteria |
| 72 | + * @return the reference to this ProjectFilter instance |
| 73 | + */ |
| 74 | + public GroupProjectsFilter withSearch(String search) { |
| 75 | + this.search = search; |
| 76 | + return (this); |
| 77 | + } |
| 78 | + |
| 79 | + /** |
| 80 | + * Return only limited fields for each project. This is a no-op without |
| 81 | + * authentication as then only simple fields are returned. |
| 82 | + * |
| 83 | + * @param simple if true, return only limited fields for each project |
| 84 | + * @return the reference to this ProjectFilter instance |
| 85 | + */ |
| 86 | + public GroupProjectsFilter withSimple(Boolean simple) { |
| 87 | + this.simple = simple; |
| 88 | + return (this); |
| 89 | + } |
| 90 | + |
| 91 | + /** |
| 92 | + * Limit by projects explicitly owned by the current user |
| 93 | + * |
| 94 | + * @param owned if true, limit to projects explicitly owned by the current user |
| 95 | + * @return the reference to this ProjectFilter instance |
| 96 | + */ |
| 97 | + public GroupProjectsFilter withOwned(Boolean owned) { |
| 98 | + this.owned = owned; |
| 99 | + return (this); |
| 100 | + } |
| 101 | + |
| 102 | + /** |
| 103 | + * Limit by projects starred by the current user. |
| 104 | + * |
| 105 | + * @param starred if true, limit by projects starred by the current user |
| 106 | + * @return the reference to this ProjectFilter instance |
| 107 | + */ |
| 108 | + public GroupProjectsFilter withStarred(Boolean starred) { |
| 109 | + this.starred = starred; |
| 110 | + return (this); |
| 111 | + } |
| 112 | + |
| 113 | + /** |
| 114 | + * Include custom attributes in response (admins only). |
| 115 | + * |
| 116 | + * @param withCustomAttributes if true, include custom attributes in the repsonse |
| 117 | + * @return the reference to this ProjectFilter instance |
| 118 | + */ |
| 119 | + public GroupProjectsFilter withCustomAttributes(Boolean withCustomAttributes) { |
| 120 | + this.withCustomAttributes = withCustomAttributes; |
| 121 | + return (this); |
| 122 | + } |
| 123 | + |
| 124 | + /** |
| 125 | + * Limit by enabled issues feature |
| 126 | + * |
| 127 | + * @param withIssuesEnabled if true, limit by enabled issues feature |
| 128 | + * @return the reference to this ProjectFilter instance |
| 129 | + */ |
| 130 | + public GroupProjectsFilter withIssuesEnabled(Boolean withIssuesEnabled) { |
| 131 | + this.withIssuesEnabled = withIssuesEnabled; |
| 132 | + return (this); |
| 133 | + } |
| 134 | + |
| 135 | + /** |
| 136 | + * Limit by enabled merge requests feature |
| 137 | + * |
| 138 | + * @param withMergeRequestsEnabled if true, imit by enabled merge requests feature |
| 139 | + * @return the reference to this ProjectFilter instance |
| 140 | + */ |
| 141 | + public GroupProjectsFilter withMergeRequestsEnabled(Boolean withMergeRequestsEnabled) { |
| 142 | + this.withMergeRequestsEnabled = withMergeRequestsEnabled; |
| 143 | + return (this); |
| 144 | + } |
| 145 | + |
| 146 | + /** |
| 147 | + * Get the query params specified by this filter. |
| 148 | + * |
| 149 | + * @return a GitLabApiForm instance holding the query parameters for this ProjectFilter instance |
| 150 | + */ |
| 151 | + public GitLabApiForm getQueryParams() { |
| 152 | + return (new GitLabApiForm() |
| 153 | + .withParam("archived", archived) |
| 154 | + .withParam("visibility", visibility) |
| 155 | + .withParam("order_by", orderBy) |
| 156 | + .withParam("sort", sort) |
| 157 | + .withParam("search", search) |
| 158 | + .withParam("simple", simple) |
| 159 | + .withParam("owned", owned) |
| 160 | + .withParam("starred", starred) |
| 161 | + .withParam("with_custom_attributes", withCustomAttributes) |
| 162 | + .withParam("with_issues_enabled", withIssuesEnabled) |
| 163 | + .withParam("with_merge_requests_enabled ", withMergeRequestsEnabled) |
| 164 | + ); |
| 165 | + } |
| 166 | +} |
0 commit comments