/*******************************************************************************
* 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.artifact;
import java.util.Collection;
import java.util.Date;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.logging.Level;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.osee.ats.internal.AtsPlugin;
import org.eclipse.osee.ats.util.AtsNotifyUsers;
import org.eclipse.osee.ats.util.AtsRelationTypes;
import org.eclipse.osee.ats.util.AtsUtil;
import org.eclipse.osee.ats.util.widgets.XActionableItemsDam;
import org.eclipse.osee.ats.util.widgets.defect.DefectManager;
import org.eclipse.osee.ats.util.widgets.role.UserRole;
import org.eclipse.osee.ats.util.widgets.role.UserRole.Role;
import org.eclipse.osee.ats.util.widgets.role.UserRoleManager;
import org.eclipse.osee.framework.core.exception.OseeCoreException;
import org.eclipse.osee.framework.core.model.Branch;
import org.eclipse.osee.framework.core.model.type.ArtifactType;
import org.eclipse.osee.framework.logging.OseeLog;
import org.eclipse.osee.framework.skynet.core.User;
import org.eclipse.osee.framework.skynet.core.UserManager;
import org.eclipse.osee.framework.skynet.core.artifact.Artifact;
import org.eclipse.osee.framework.skynet.core.artifact.ArtifactFactory;
import org.eclipse.osee.framework.skynet.core.transaction.SkynetTransaction;
/**
* @author Donald G. Dunne
*/
public abstract class ReviewSMArtifact extends TaskableStateMachineArtifact {
protected DefectManager defectManager;
protected UserRoleManager userRoleManager;
private XActionableItemsDam actionableItemsDam;
private Collection<UserRole> preSaveReviewRoleComplete;
Boolean standAlone = null;
public static enum ReviewBlockType {
None,
Transition,
Commit
};
public ReviewSMArtifact(ArtifactFactory parentFactory, String guid, String humanReadableId, Branch branch, ArtifactType artifactType) throws OseeCoreException {
super(parentFactory, guid, humanReadableId, branch, artifactType);
}
@Override
public void onInitializationComplete() throws OseeCoreException {
super.onInitializationComplete();
initializeSMA();
};
@Override
public Set<User> getPrivilegedUsers() throws OseeCoreException {
Set<User> users = new HashSet<User>();
if (getParentTeamWorkflow() != null) {
users.addAll(getParentTeamWorkflow().getPrivilegedUsers());
}
for (ActionableItemArtifact aia : getActionableItemsDam().getActionableItems()) {
for (TeamDefinitionArtifact teamDef : aia.getImpactedTeamDefs()) {
addPriviledgedUsersUpTeamDefinitionTree(teamDef, users);
}
}
if (AtsUtil.isAtsAdmin()) {
users.add(UserManager.getUser());
}
return users;
}
@Override
public void onAttributePersist(SkynetTransaction transaction) {
super.onAttributePersist(transaction);
// Since multiple ways exist to change the assignees, notification is performed on the persist
if (isDeleted()) {
return;
}
try {
notifyReviewersComplete();
} catch (Exception ex) {
OseeLog.log(AtsPlugin.class, Level.SEVERE, ex);
}
}
@Override
public void initalizePreSaveCache() {
super.initalizePreSaveCache();
try {
preSaveReviewRoleComplete = getRoleUsersReviewComplete();
} catch (Exception ex) {
OseeLog.log(AtsPlugin.class, Level.SEVERE, ex);
}
}
private Collection<UserRole> getRoleUsersReviewComplete() throws OseeCoreException {
return this.getUserRoleManager().getRoleUsersReviewComplete();
}
public void notifyReviewersComplete() throws OseeCoreException {
UserRoleManager userRoleManager = this.getUserRoleManager();
if (!preSaveReviewRoleComplete.equals(userRoleManager.getRoleUsersReviewComplete())) {
//all reviewers are complete; send notification to author/moderator
if (userRoleManager.getUserRoles(Role.Reviewer).equals(userRoleManager.getRoleUsersReviewComplete())) {
AtsNotifyUsers.getInstance().notify(this, AtsNotifyUsers.NotifyType.Reviewed);
}
}
preSaveReviewRoleComplete = userRoleManager.getRoleUsersReviewComplete();
}
/**
* Reset managers for case where artifact is re-loaded/initialized
*
* @see org.eclipse.osee.ats.artifact.StateMachineArtifact#initialize()
*/
@Override
protected void initializeSMA() throws OseeCoreException {
super.initializeSMA();
defectManager = new DefectManager(this);
userRoleManager = new UserRoleManager(this);
actionableItemsDam = new XActionableItemsDam(this);
}
@Override
public String getArtifactSuperTypeName() {
return "Review";
}
public boolean isBlocking() throws OseeCoreException {
return getReviewBlockType() != ReviewBlockType.None;
}
public ReviewBlockType getReviewBlockType() throws OseeCoreException {
String typeStr = getSoleAttributeValue(AtsAttributeTypes.ReviewBlocks, null);
if (typeStr == null) {
// Check old attribute value
if (getSoleAttributeValue(AtsAttributeTypes.BlockingReview, false) == true) {
return ReviewBlockType.Transition;
}
return ReviewBlockType.None;
}
return ReviewBlockType.valueOf(typeStr);
}
public DefectManager getDefectManager() {
if (defectManager == null) {
defectManager = new DefectManager(this);
}
return defectManager;
}
@Override
public String getHyperTargetVersion() {
return null;
}
public UserRoleManager getUserRoleManager() {
if (userRoleManager == null) {
return userRoleManager = new UserRoleManager(this);
}
return userRoleManager;
}
@SuppressWarnings("unused")
public IStatus isUserRoleValid(String namespace) throws OseeCoreException {
// Need this cause it removes all error items of this namespace
return new Status(IStatus.OK, namespace, "");
}
public Set<TeamDefinitionArtifact> getCorrespondingTeamDefinitionArtifact() throws OseeCoreException {
Set<TeamDefinitionArtifact> teamDefs = new HashSet<TeamDefinitionArtifact>();
if (getParentTeamWorkflow() != null) {
teamDefs.add(getParentTeamWorkflow().getTeamDefinition());
}
if (getActionableItemsDam().getActionableItems().size() > 0) {
teamDefs.addAll(ActionableItemArtifact.getImpactedTeamDefs(getActionableItemsDam().getActionableItems()));
}
return teamDefs;
}
/**
* @return the actionableItemsDam
*/
public XActionableItemsDam getActionableItemsDam() throws OseeCoreException {
if (actionableItemsDam == null) {
actionableItemsDam = new XActionableItemsDam(this);
}
return actionableItemsDam;
}
@Override
public StateMachineArtifact getParentSMA() throws OseeCoreException {
if (isStandAloneReview()) {
return null;
}
if (parentSma != null) {
return parentSma;
}
parentSma = getParentTeamWorkflow();
return parentSma;
}
@Override
public ActionArtifact getParentActionArtifact() throws OseeCoreException {
if (isStandAloneReview()) {
return null;
}
if (parentAction != null) {
return parentAction;
}
parentTeamArt = getParentTeamWorkflow();
if (parentTeamArt != null) {
parentAction = parentTeamArt.getParentActionArtifact();
}
return parentAction;
}
@Override
public TeamWorkFlowArtifact getParentTeamWorkflow() throws OseeCoreException {
if (isStandAloneReview()) {
return null;
}
if (parentTeamArt != null) {
return parentTeamArt;
}
List<TeamWorkFlowArtifact> teams =
getRelatedArtifacts(AtsRelationTypes.TeamWorkflowToReview_Team, TeamWorkFlowArtifact.class);
if (teams.size() > 1) {
OseeLog.log(AtsPlugin.class, Level.SEVERE,
getArtifactTypeName() + " " + getHumanReadableId() + " has multiple parent workflows");
} else if (!isStandAloneReview() && teams.isEmpty()) {
OseeLog.log(AtsPlugin.class, Level.SEVERE,
getArtifactTypeName() + " " + getHumanReadableId() + " has no parent workflow");
}
if (teams.size() > 0) {
parentTeamArt = teams.iterator().next();
}
return parentTeamArt;
}
public boolean isStandAloneReview() throws OseeCoreException {
if (standAlone == null) {
standAlone = getActionableItemsDam().getActionableItemGuids().size() > 0;
}
return standAlone;
}
@Override
public String getWorldViewParentID() throws OseeCoreException {
return getParentTeamWorkflow().getHumanReadableId();
}
@Override
public Date getWorldViewDeadlineDate() {
return null;
}
@Override
public String getWorldViewCategory() {
return "";
}
@Override
public Date getWorldViewReleaseDate() {
return null;
}
@Override
public String getWorldViewTeam() throws OseeCoreException {
TeamWorkFlowArtifact teamDef = getParentTeamWorkflow();
if (teamDef != null) {
return teamDef.getWorldViewTeam();
}
return "";
}
@SuppressWarnings("unused")
@Override
public String getWorldViewReviewDecider() throws OseeCoreException {
return "";
}
@SuppressWarnings("unused")
@Override
public String getWorldViewReviewModerator() throws OseeCoreException {
return "";
}
@SuppressWarnings("unused")
@Override
public String getWorldViewReviewReviewer() throws OseeCoreException {
return "";
}
@SuppressWarnings("unused")
@Override
public String getWorldViewReviewAuthor() throws OseeCoreException {
return "";
}
@Override
public double getWorldViewWeeklyBenefit() {
return 0;
}
@Override
public String getWorldViewWorkPackage() {
return "";
}
public Artifact getArtifact() {
return this;
}
@Override
public String getWorldViewCategory2() {
return "";
}
@Override
public String getWorldViewCategory3() {
return "";
}
@Override
public String getWorldViewDeadlineDateStr() {
return "";
}
}
