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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
/*******************************************************************************
* Copyright (c) 2013 Boeing.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Boeing - initial API and implementation
*******************************************************************************/
package org.eclipse.osee.orcs.rest.client;
import java.util.Collection;
import java.util.List;
import org.eclipse.osee.framework.core.data.IArtifactToken;
import org.eclipse.osee.framework.core.data.IArtifactType;
import org.eclipse.osee.framework.core.data.IAttributeType;
import org.eclipse.osee.framework.core.data.IRelationType;
import org.eclipse.osee.framework.core.data.IRelationTypeSide;
import org.eclipse.osee.framework.core.data.TokenFactory;
import org.eclipse.osee.framework.core.data.TransactionId;
import org.eclipse.osee.framework.core.enums.QueryOption;
import org.eclipse.osee.framework.jdk.core.type.OseeCoreException;
import org.eclipse.osee.orcs.rest.model.search.artifact.RequestType;
import org.eclipse.osee.orcs.rest.model.search.artifact.SearchResult;
/**
* @author Ryan D. Brooks
* @author Roberto E. Escobar
*/
public interface QueryBuilder {
public static IAttributeType ANY_ATTRIBUTE_TYPE =
TokenFactory.createAttributeType(Long.MIN_VALUE, "Any Attribute Type");
QueryBuilder includeDeleted();
QueryBuilder includeDeleted(boolean enabled);
boolean areDeletedIncluded();
QueryBuilder fromTransaction(TransactionId transactionId);
TransactionId getFromTransaction();
QueryBuilder headTransaction();
boolean isHeadTransaction();
QueryBuilder excludeDeleted();
/**
* Search criteria that finds a given artifact id
*/
QueryBuilder andLocalId(int... artifactId) throws OseeCoreException;
/**
* Search criteria that finds a given artifact ids
*/
QueryBuilder andLocalIds(Collection<Integer> artifactIds) throws OseeCoreException;
/**
* Search criteria that finds a given artifact with guids
*/
QueryBuilder andGuids(String... ids) throws OseeCoreException;
/**
* Search criteria that finds a given artifact with guids
*/
QueryBuilder andGuids(Collection<String> ids) throws OseeCoreException;
/**
* Artifacts matching token id(s)
*/
QueryBuilder andIds(IArtifactToken... artifactToken) throws OseeCoreException;
/**
* Artifacts matching token id(s)
*/
QueryBuilder andIds(Collection<? extends IArtifactToken> artifactTokens) throws OseeCoreException;
/**
* Search criteria that finds a given artifact type using type inheritance
*/
QueryBuilder andIsOfType(IArtifactType... artifactType) throws OseeCoreException;
/**
* Search criteria that finds a given artifact types using type inheritance
*/
QueryBuilder andIsOfType(Collection<? extends IArtifactType> artifactType) throws OseeCoreException;
/**
* Search criteria that finds a given artifact type by matching type exactly
*/
QueryBuilder andTypeEquals(IArtifactType... artifactType) throws OseeCoreException;
/**
* Search criteria that finds a given artifact types by matching type exactly
*/
QueryBuilder andTypeEquals(Collection<? extends IArtifactType> artifactType) throws OseeCoreException;
/**
* Search criteria that checks for the existence of an attribute type(s).
*/
QueryBuilder andExists(IAttributeType... attributeType) throws OseeCoreException;
/**
* Search criteria that checks for the existence of an attribute types.
*/
QueryBuilder andExists(Collection<? extends IAttributeType> attributeTypes) throws OseeCoreException;
/**
* Search criteria that checks for the non-existence of an attribute type(s).
*/
QueryBuilder andNotExists(IAttributeType attributeType) throws OseeCoreException;
/**
* Search criteria that checks for the non-existence of an attribute type(s).
*/
QueryBuilder andNotExists(Collection<? extends IAttributeType> attributeTypes) throws OseeCoreException;
/**
* Search criteria that follows the relation link ending on the given side
*
* @param relationType the type to start following the link from
*/
QueryBuilder andExists(IRelationType relationType) throws OseeCoreException;
/**
* Search criteria that follows the relation link ending on the given side
*
* @param relationTypeSide the type to start following the link from
*/
QueryBuilder andExists(IRelationTypeSide relationTypeSide) throws OseeCoreException;
/**
* Search criteria that checks for non-existence of a relation type
*
* @param relationType the type to check for non-existence
*/
QueryBuilder andNotExists(IRelationType relationType) throws OseeCoreException;
/**
* Search criteria that checks for non-existence of a relation type
*
* @param relationTypeSide the type to check for non-existence
*/
QueryBuilder andNotExists(IRelationTypeSide relationTypeSide) throws OseeCoreException;
/**
* Artifact name equals value
*/
QueryBuilder andNameEquals(String artifactName) throws OseeCoreException;
/**
* Search criteria that finds an attribute of the given type with its current value exactly equal (or not equal) to
* any one of the given literal values. If the list only contains one value, then the search is conducted exactly as
* if the single value constructor was called. This search does not support the (* wildcard) for multiple values.
*/
QueryBuilder and(IAttributeType attributeType, Collection<String> values, QueryOption... options) throws OseeCoreException;
/**
* Search criteria that finds an attribute of the given type with its current value relative to the given value based
* on the operator provided.
*/
QueryBuilder and(IAttributeType attributeType, String value, QueryOption... options) throws OseeCoreException;
/**
* Search criteria that finds an attribute of the given type with its current value exactly equal (or not equal) to
* any one of the given literal values. If the list only contains one value, then the search is conducted exactly as
* if the single value constructor was called. This search does not support the (* wildcard) for multiple values.
*/
QueryBuilder and(Collection<? extends IAttributeType> attributeTypes, String value, QueryOption... options) throws OseeCoreException;
/**
* Search for related artifacts
*
* @param relationTypeSide the type-side to search on
*/
QueryBuilder andRelatedTo(IRelationTypeSide relationTypeSide, IArtifactToken... artifacts) throws OseeCoreException;
/**
* Search for related artifacts
*
* @param relationTypeSide the type-side to search on
*/
QueryBuilder andRelatedTo(IRelationTypeSide relationTypeSide, Collection<? extends IArtifactToken> artifacts) throws OseeCoreException;
/**
* Search for related artifacts
*
* @param relationTypeSide the type-side to search on
*/
QueryBuilder andRelatedToLocalIds(IRelationTypeSide relationTypeSide, int... artifactIds) throws OseeCoreException;
/**
* Search for related artifacts
*
* @param relationTypeSide the type-side to search on
*/
QueryBuilder andRelatedToLocalIds(IRelationTypeSide relationTypeSide, Collection<Integer> artifactIds) throws OseeCoreException;
/**
* Executes query
*
* @return artifact search results
*/
SearchResult getSearchResult(RequestType request) throws OseeCoreException;
/**
* Count search results
*/
int getCount() throws OseeCoreException;
/**
* Convenience method for getting art ids of results
*
* @return artifact search ids
*/
List<Integer> getIds();
QueryBuilder getQueryBuilder();
}
|
