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
|
/*******************************************************************************
* Copyright (c) 2004, 2007 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.ats.core.client.review;
import java.util.Arrays;
import java.util.Collection;
import java.util.Date;
import org.eclipse.osee.ats.api.ai.IAtsActionableItem;
import org.eclipse.osee.ats.api.data.AtsArtifactTypes;
import org.eclipse.osee.ats.api.data.AtsAttributeTypes;
import org.eclipse.osee.ats.api.data.AtsRelationTypes;
import org.eclipse.osee.ats.api.user.IAtsUser;
import org.eclipse.osee.ats.api.util.IAtsChangeSet;
import org.eclipse.osee.ats.api.workdef.IAtsWorkDefinition;
import org.eclipse.osee.ats.api.workdef.IStateToken;
import org.eclipse.osee.ats.api.workdef.ReviewBlockType;
import org.eclipse.osee.ats.api.workdef.StateType;
import org.eclipse.osee.ats.api.workflow.transition.TransitionOption;
import org.eclipse.osee.ats.api.workflow.transition.TransitionResults;
import org.eclipse.osee.ats.core.client.internal.AtsClientService;
import org.eclipse.osee.ats.core.client.review.defect.ReviewDefectItem;
import org.eclipse.osee.ats.core.client.review.defect.ReviewDefectManager;
import org.eclipse.osee.ats.core.client.review.role.UserRole;
import org.eclipse.osee.ats.core.client.review.role.UserRoleManager;
import org.eclipse.osee.ats.core.client.team.TeamWorkFlowArtifact;
import org.eclipse.osee.ats.core.client.util.AtsUtilCore;
import org.eclipse.osee.ats.core.workflow.transition.TransitionHelper;
import org.eclipse.osee.ats.core.workflow.transition.TransitionManager;
import org.eclipse.osee.framework.core.util.Result;
import org.eclipse.osee.framework.jdk.core.type.OseeCoreException;
import org.eclipse.osee.framework.skynet.core.artifact.ArtifactTypeManager;
/**
* Methods in support of programatically transitioning the Peer Review Workflow through it's states. Only to be used for
* the DefaultReviewWorkflow of Prepare->Review->Complete
*
* @author Donald G. Dunne
*/
public class PeerToPeerReviewManager {
public static String getDefaultReviewTitle(TeamWorkFlowArtifact teamArt) {
return "Review \"" + teamArt.getArtifactTypeName() + "\" titled \"" + teamArt.getName() + "\"";
}
protected PeerToPeerReviewManager() {
// private constructor
}
/**
* Quickly transition to a state with minimal metrics and data entered. Should only be used for automated transition
* for things such as developmental testing and demos.
*
* @param user User to transition to OR null if should use user of current state
*/
public static Result transitionTo(PeerToPeerReviewArtifact reviewArt, PeerToPeerReviewState toState, Collection<UserRole> roles, Collection<ReviewDefectItem> defects, IAtsUser user, boolean popup, IAtsChangeSet changes) throws OseeCoreException {
Result result = setPrepareStateData(popup, reviewArt, roles, "DoThis.java", 100, .2, changes);
if (result.isFalse()) {
return result;
}
result =
transitionToState(PeerToPeerReviewState.Review.getStateType(), popup, reviewArt, PeerToPeerReviewState.Review,
changes);
if (result.isFalse()) {
return result;
}
if (toState == PeerToPeerReviewState.Review) {
return Result.TrueResult;
}
result = setReviewStateData(reviewArt, roles, defects, 100, .2, changes);
if (result.isFalse()) {
return result;
}
result =
transitionToState(PeerToPeerReviewState.Completed.getStateType(), popup, reviewArt,
PeerToPeerReviewState.Completed, changes);
if (result.isFalse()) {
return result;
}
return Result.TrueResult;
}
private static Result transitionToState(StateType StateType, boolean popup, PeerToPeerReviewArtifact reviewArt, IStateToken toState, IAtsChangeSet changes) throws OseeCoreException {
TransitionHelper helper =
new TransitionHelper("Transition to " + toState.getName(), Arrays.asList(reviewArt), toState.getName(),
Arrays.asList(reviewArt.getStateMgr().getAssignees().iterator().next()), null,
changes, TransitionOption.OverrideAssigneeCheck);
TransitionManager transitionMgr = new TransitionManager(helper);
TransitionResults results = transitionMgr.handleAll();
if (results.isEmpty()) {
return Result.TrueResult;
}
return new Result("Error transitioning [%s]", results);
}
public static Result setPrepareStateData(boolean popup, PeerToPeerReviewArtifact reviewArt, Collection<UserRole> roles, String reviewMaterials, int statePercentComplete, double stateHoursSpent, IAtsChangeSet changes) throws OseeCoreException {
if (!reviewArt.isInState(PeerToPeerReviewState.Prepare)) {
Result result = new Result("Action not in Prepare state");
if (result.isFalse() && popup) {
return result;
}
}
if (roles != null) {
UserRoleManager roleMgr = new UserRoleManager(reviewArt);
for (UserRole role : roles) {
roleMgr.addOrUpdateUserRole(role, reviewArt);
}
roleMgr.saveToArtifact(changes);
}
reviewArt.setSoleAttributeValue(AtsAttributeTypes.Location, reviewMaterials);
reviewArt.setSoleAttributeValue(AtsAttributeTypes.ReviewFormalType, ReviewFormalType.InFormal.name());
reviewArt.getStateMgr().updateMetrics(reviewArt.getStateDefinition(), stateHoursSpent, statePercentComplete, true);
return Result.TrueResult;
}
public static Result setReviewStateData(PeerToPeerReviewArtifact reviewArt, Collection<UserRole> roles, Collection<ReviewDefectItem> defects, int statePercentComplete, double stateHoursSpent, IAtsChangeSet changes) throws OseeCoreException {
if (roles != null) {
UserRoleManager roleMgr = new UserRoleManager(reviewArt);
for (UserRole role : roles) {
roleMgr.addOrUpdateUserRole(role, reviewArt);
}
roleMgr.saveToArtifact(changes);
}
if (defects != null) {
ReviewDefectManager defectManager = new ReviewDefectManager(reviewArt);
for (ReviewDefectItem defect : defects) {
defectManager.addOrUpdateDefectItem(defect);
}
defectManager.saveToArtifact(reviewArt);
}
reviewArt.getStateMgr().updateMetrics(reviewArt.getStateDefinition(), stateHoursSpent, statePercentComplete, true);
return Result.TrueResult;
}
public static PeerToPeerReviewArtifact createNewPeerToPeerReview(TeamWorkFlowArtifact teamArt, String reviewTitle, String againstState, IAtsChangeSet changes) throws OseeCoreException {
return createNewPeerToPeerReview(teamArt, reviewTitle, againstState, new Date(),
AtsClientService.get().getUserAdmin().getCurrentUser(), changes);
}
public static PeerToPeerReviewArtifact createNewPeerToPeerReview(IAtsWorkDefinition workDefinition, TeamWorkFlowArtifact teamArt, String reviewTitle, String againstState, IAtsChangeSet changes) throws OseeCoreException {
return createNewPeerToPeerReview(workDefinition, teamArt, reviewTitle, againstState, new Date(),
AtsClientService.get().getUserAdmin().getCurrentUser(), changes);
}
public static PeerToPeerReviewArtifact createNewPeerToPeerReview(TeamWorkFlowArtifact teamArt, String reviewTitle, String againstState, Date createdDate, IAtsUser createdBy, IAtsChangeSet changes) throws OseeCoreException {
return createNewPeerToPeerReview(
AtsClientService.get().getWorkDefinitionAdmin().getWorkDefinitionForPeerToPeerReviewNotYetCreated(teamArt).getWorkDefinition(),
teamArt, reviewTitle, againstState, createdDate, createdBy, changes);
}
public static PeerToPeerReviewArtifact createNewPeerToPeerReview(IAtsActionableItem actionableItem, String reviewTitle, String againstState, Date createdDate, IAtsUser createdBy, IAtsChangeSet changes) throws OseeCoreException {
PeerToPeerReviewArtifact peerArt =
createNewPeerToPeerReview(
AtsClientService.get().getWorkDefinitionAdmin().getWorkDefinitionForPeerToPeerReviewNotYetCreatedAndStandalone(
actionableItem).getWorkDefinition(), null, reviewTitle, againstState, createdDate, createdBy,
changes);
peerArt.getActionableItemsDam().addActionableItem(actionableItem);
changes.add(peerArt);
return peerArt;
}
public static PeerToPeerReviewArtifact createNewPeerToPeerReview(IAtsWorkDefinition workDefinition, TeamWorkFlowArtifact teamArt, String reviewTitle, String againstState, Date createdDate, IAtsUser createdBy, IAtsChangeSet changes) throws OseeCoreException {
PeerToPeerReviewArtifact peerToPeerRev =
(PeerToPeerReviewArtifact) ArtifactTypeManager.addArtifact(AtsArtifactTypes.PeerToPeerReview,
AtsUtilCore.getAtsBranch(), reviewTitle == null ? "Peer to Peer Review" : reviewTitle);
if (teamArt != null) {
teamArt.addRelation(AtsRelationTypes.TeamWorkflowToReview_Review, peerToPeerRev);
}
// Initialize state machine
peerToPeerRev.setSoleAttributeValue(AtsAttributeTypes.WorkflowDefinition, workDefinition.getId());
peerToPeerRev.initializeNewStateMachine(workDefinition, null, new Date(), createdBy);
if (teamArt != null && againstState != null) {
peerToPeerRev.setSoleAttributeValue(AtsAttributeTypes.RelatedToState, againstState);
}
peerToPeerRev.setSoleAttributeValue(AtsAttributeTypes.ReviewBlocks, ReviewBlockType.None.name());
changes.add(peerToPeerRev);
AtsReviewCache.decache(teamArt);
return peerToPeerRev;
}
public static boolean isStandAlongReview(Object object) throws OseeCoreException {
if (object instanceof PeerToPeerReviewArtifact) {
PeerToPeerReviewArtifact peerArt = (PeerToPeerReviewArtifact) object;
return peerArt.isStandAloneReview();
}
return false;
}
}
|
