Home

Contribute

Source code


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

/*******************************************************************************
 * 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.search;

import java.util.Collection;
import org.eclipse.osee.executor.admin.CancellableCallable;
import org.eclipse.osee.framework.core.data.IOseeBranch;
import org.eclipse.osee.framework.core.data.ResultSet;
import org.eclipse.osee.framework.core.enums.BranchState;
import org.eclipse.osee.framework.core.enums.BranchType;
import org.eclipse.osee.framework.jdk.core.type.OseeCoreException;
import org.eclipse.osee.orcs.data.BranchReadable;

/**
 * @author Ryan D. Brooks
 * @author Roberto E. Escobar
 */
public interface BranchQuery {

   BranchQuery includeDeleted();

   BranchQuery excludeDeleted();

   BranchQuery includeDeleted(boolean enabled);

   boolean areDeletedIncluded();

   BranchQuery includeArchived();

   BranchQuery includeArchived(boolean enabled);

   BranchQuery excludeArchived();

   boolean areArchivedIncluded();

   BranchQuery andLocalId(int... id) throws OseeCoreException;

   BranchQuery andLocalIds(Collection<Integer> ids) throws OseeCoreException;

   BranchQuery andUuids(String... ids) throws OseeCoreException;

   BranchQuery andUuids(Collection<String> ids) throws OseeCoreException;

   BranchQuery andIds(Collection<? extends IOseeBranch> ids) throws OseeCoreException;

   BranchQuery andIds(IOseeBranch... ids) throws OseeCoreException;

   BranchQuery andIsOfType(BranchType... branchType) throws OseeCoreException;

   BranchQuery andStateIs(BranchState... branchState) throws OseeCoreException;

   BranchQuery andNameEquals(String value) throws OseeCoreException;

   BranchQuery andNamePattern(String pattern) throws OseeCoreException;

   BranchQuery andIsChildOf(IOseeBranch branch) throws OseeCoreException;

   BranchQuery andIsAncestorOf(IOseeBranch branch) throws OseeCoreException;

   ResultSet<BranchReadable> getResults() throws OseeCoreException;

   ResultSet<IOseeBranch> getResultsAsId() throws OseeCoreException;

   int getCount() throws OseeCoreException;

   CancellableCallable<Integer> createCount() throws OseeCoreException;

   CancellableCallable<ResultSet<BranchReadable>> createSearch() throws OseeCoreException;

   CancellableCallable<ResultSet<IOseeBranch>> createSearchResultsAsIds() throws OseeCoreException;

}