feature[ats_ATS159904]: Consolidate all usage of DH root artifact

Change-Id: Iabc523f3ad50ae1418bf864debf988e98808f08b

12 files changed, 30 insertions, 29 deletions

diff --git a/plugins/org.eclipse.osee.ats.impl/src/org/eclipse/osee/ats/impl/internal/agile/AgileService.java b/plugins/org.eclipse.osee.ats.impl/src/org/eclipse/osee/ats/impl/internal/agile/AgileService.java
index 241cdbd0819..f6352fc5644 100644
--- a/plugins/org.eclipse.osee.ats.impl/src/org/eclipse/osee/ats/impl/internal/agile/AgileService.java
+++ b/plugins/org.eclipse.osee.ats.impl/src/org/eclipse/osee/ats/impl/internal/agile/AgileService.java
@@ -25,7 +25,6 @@ import org.eclipse.osee.ats.core.users.AtsCoreUsers;
 import org.eclipse.osee.ats.core.util.AtsUtilCore;
 import org.eclipse.osee.ats.impl.IAtsServer;
 import org.eclipse.osee.ats.impl.internal.util.AtsChangeSet;
-import org.eclipse.osee.framework.core.enums.CoreArtifactTokens;
 import org.eclipse.osee.framework.core.enums.CoreArtifactTypes;
 import org.eclipse.osee.framework.core.enums.CoreBranches;
 import org.eclipse.osee.framework.core.enums.CoreRelationTypes;
@@ -102,10 +101,9 @@ public class AgileService implements IAgileService {
             AtsArtifactToken.TopAgileFolder).getResults().getAtMostOneOrNull();
       if (agileFolder == null) {
          agileFolder = tx.createArtifact(AtsArtifactToken.TopAgileFolder);
-         ArtifactReadable defaultHierarchyRoot =
-            atsServer.getOrcsApi().getQueryFactory(null).fromBranch(CoreBranches.COMMON).andIds(
-               CoreArtifactTokens.DefaultHierarchyRoot).getResults().getExactlyOne();
-         tx.addChildren(defaultHierarchyRoot, agileFolder);
+         ArtifactReadable rootArtifact =
+            atsServer.getOrcsApi().getQueryFactory(null).fromBranch(AtsUtilCore.getAtsBranch()).andIsHeirarchicalRootArtifact().getResults().getExactlyOne();
+         tx.addChildren(rootArtifact, agileFolder);
       }
       return (ArtifactReadable) agileFolder;
    }
diff --git a/plugins/org.eclipse.osee.ats/src/org/eclipse/osee/ats/navigate/FilteredCheckboxTreeArtifactDialogExample.java b/plugins/org.eclipse.osee.ats/src/org/eclipse/osee/ats/navigate/FilteredCheckboxTreeArtifactDialogExample.java
index d38e9f1e730..cf49998f391 100644
--- a/plugins/org.eclipse.osee.ats/src/org/eclipse/osee/ats/navigate/FilteredCheckboxTreeArtifactDialogExample.java
+++ b/plugins/org.eclipse.osee.ats/src/org/eclipse/osee/ats/navigate/FilteredCheckboxTreeArtifactDialogExample.java
@@ -14,9 +14,8 @@ import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 import org.eclipse.osee.ats.core.util.AtsUtilCore;
-import org.eclipse.osee.framework.core.enums.CoreArtifactTokens;
+import org.eclipse.osee.framework.skynet.core.OseeSystemArtifacts;
 import org.eclipse.osee.framework.skynet.core.artifact.Artifact;
-import org.eclipse.osee.framework.skynet.core.artifact.search.ArtifactQuery;
 import org.eclipse.osee.framework.ui.plugin.xnavigate.XNavigateComposite.TableLoadOption;
 import org.eclipse.osee.framework.ui.plugin.xnavigate.XNavigateItem;
 import org.eclipse.osee.framework.ui.plugin.xnavigate.XNavigateItemAction;
@@ -36,8 +35,7 @@ public class FilteredCheckboxTreeArtifactDialogExample extends XNavigateItemActi
 
    @Override
    public void run(TableLoadOption... tableLoadOptions) throws Exception {
-      Artifact rootArtifact =
-         ArtifactQuery.getArtifactFromToken(CoreArtifactTokens.DefaultHierarchyRoot, AtsUtilCore.getAtsBranch());
+      Artifact rootArtifact = OseeSystemArtifacts.getDefaultHierarchyRootArtifact(AtsUtilCore.getAtsBranch());
       List<Artifact> initialSelection = new ArrayList<Artifact>();
       List<Artifact> children = rootArtifact.getChildren();
       initialSelection.add(children.iterator().next());
diff --git a/plugins/org.eclipse.osee.ats/src/org/eclipse/osee/ats/navigate/FilteredTreeArtifactDialogExample.java b/plugins/org.eclipse.osee.ats/src/org/eclipse/osee/ats/navigate/FilteredTreeArtifactDialogExample.java
index 058f509c556..88f6123c85b 100644
--- a/plugins/org.eclipse.osee.ats/src/org/eclipse/osee/ats/navigate/FilteredTreeArtifactDialogExample.java
+++ b/plugins/org.eclipse.osee.ats/src/org/eclipse/osee/ats/navigate/FilteredTreeArtifactDialogExample.java
@@ -12,9 +12,8 @@ package org.eclipse.osee.ats.navigate;
 
 import java.util.List;
 import org.eclipse.osee.ats.core.util.AtsUtilCore;
-import org.eclipse.osee.framework.core.enums.CoreArtifactTokens;
+import org.eclipse.osee.framework.skynet.core.OseeSystemArtifacts;
 import org.eclipse.osee.framework.skynet.core.artifact.Artifact;
-import org.eclipse.osee.framework.skynet.core.artifact.search.ArtifactQuery;
 import org.eclipse.osee.framework.ui.plugin.xnavigate.XNavigateComposite.TableLoadOption;
 import org.eclipse.osee.framework.ui.plugin.xnavigate.XNavigateItem;
 import org.eclipse.osee.framework.ui.plugin.xnavigate.XNavigateItemAction;
@@ -36,8 +35,7 @@ public class FilteredTreeArtifactDialogExample extends XNavigateItemAction {
 
    @Override
    public void run(TableLoadOption... tableLoadOptions) throws Exception {
-      Artifact rootArtifact =
-         ArtifactQuery.getArtifactFromToken(CoreArtifactTokens.DefaultHierarchyRoot, AtsUtilCore.getAtsBranch());
+      Artifact rootArtifact = OseeSystemArtifacts.getDefaultHierarchyRootArtifact(AtsUtilCore.getAtsBranch());
       List<Artifact> children = rootArtifact.getChildren();
       FilteredTreeArtifactDialog dialog =
          new FilteredTreeArtifactDialog("My Title", "Message", children, new ArtifactTreeContentProvider(),
diff --git a/plugins/org.eclipse.osee.framework.core/src/org/eclipse/osee/framework/core/enums/CoreArtifactTokens.java b/plugins/org.eclipse.osee.framework.core/src/org/eclipse/osee/framework/core/enums/CoreArtifactTokens.java
index 12d333bde17..27901020236 100644
--- a/plugins/org.eclipse.osee.framework.core/src/org/eclipse/osee/framework/core/enums/CoreArtifactTokens.java
+++ b/plugins/org.eclipse.osee.framework.core/src/org/eclipse/osee/framework/core/enums/CoreArtifactTokens.java
@@ -17,7 +17,7 @@ public final class CoreArtifactTokens {
 
    // @formatter:off
    public static IArtifactToken DefaultHierarchyRoot = TokenFactory.createArtifactToken("AEslkN+d4hWXjQvnZ1gA", "Default Hierarchy Root", CoreArtifactTypes.RootArtifact);
-   public static IArtifactToken GroupRoot = TokenFactory.createArtifactToken("AExdLMeOTGhhPY4CyvQA", "Root Artifact", CoreArtifactTypes.UniversalGroup);
+   public static IArtifactToken UniversalGroupRoot = TokenFactory.createArtifactToken("AExdLMeOTGhhPY4CyvQA", "Root Artifact", CoreArtifactTypes.UniversalGroup);
    public static IArtifactToken Everyone = TokenFactory.createArtifactToken("AAABEbn4DKoAaR82FZsL3A", "Everyone", CoreArtifactTypes.UserGroup);
    public static IArtifactToken OseeAdmin = TokenFactory.createArtifactToken("AAABHaItmnUAG6ZAYlFKag", "OseeAdmin", CoreArtifactTypes.UserGroup);
    public static IArtifactToken UserGroups = TokenFactory.createArtifactToken("AAABGTAGNY8BauB5GajiIQ", "User Groups", CoreArtifactTypes.Folder);
diff --git a/plugins/org.eclipse.osee.framework.database.init/src/org/eclipse/osee/framework/database/init/AddCommonBranch.java b/plugins/org.eclipse.osee.framework.database.init/src/org/eclipse/osee/framework/database/init/AddCommonBranch.java
index bcd8e53083b..d08dc98f55a 100644
--- a/plugins/org.eclipse.osee.framework.database.init/src/org/eclipse/osee/framework/database/init/AddCommonBranch.java
+++ b/plugins/org.eclipse.osee.framework.database.init/src/org/eclipse/osee/framework/database/init/AddCommonBranch.java
@@ -61,7 +61,7 @@ public abstract class AddCommonBranch implements IDbInitializationTask {
       if (initializeRootArtifacts) {
          ArtifactTypeManager.addArtifact(CoreArtifactTokens.DefaultHierarchyRoot, CoreBranches.SYSTEM_ROOT).persist(
             getClass().getSimpleName());
-         ArtifactTypeManager.addArtifact(CoreArtifactTokens.GroupRoot, CoreBranches.SYSTEM_ROOT).persist(
+         ArtifactTypeManager.addArtifact(CoreArtifactTokens.UniversalGroupRoot, CoreBranches.SYSTEM_ROOT).persist(
             getClass().getSimpleName());
 
          BranchManager.createTopLevelBranch(CoreBranches.COMMON);
diff --git a/plugins/org.eclipse.osee.framework.skynet.core/src/org/eclipse/osee/framework/skynet/core/OseeSystemArtifacts.java b/plugins/org.eclipse.osee.framework.skynet.core/src/org/eclipse/osee/framework/skynet/core/OseeSystemArtifacts.java
index 563599aefec..b440475db8d 100644
--- a/plugins/org.eclipse.osee.framework.skynet.core/src/org/eclipse/osee/framework/skynet/core/OseeSystemArtifacts.java
+++ b/plugins/org.eclipse.osee.framework.skynet.core/src/org/eclipse/osee/framework/skynet/core/OseeSystemArtifacts.java
@@ -13,6 +13,7 @@ package org.eclipse.osee.framework.skynet.core;
 import org.eclipse.osee.framework.core.data.IArtifactToken;
 import org.eclipse.osee.framework.core.data.IArtifactType;
 import org.eclipse.osee.framework.core.data.IOseeBranch;
+import org.eclipse.osee.framework.core.enums.CoreArtifactTokens;
 import org.eclipse.osee.framework.core.enums.CoreArtifactTypes;
 import org.eclipse.osee.framework.core.exception.ArtifactDoesNotExist;
 import org.eclipse.osee.framework.core.model.Branch;
@@ -30,8 +31,6 @@ import org.eclipse.osee.framework.skynet.core.artifact.search.ArtifactQuery;
  * @author Ryan D. Brooks
  */
 public final class OseeSystemArtifacts {
-   public static final String DEFAULT_HIERARCHY_ROOT_NAME = "Default Hierarchy Root";
-   public static final String ROOT_ARTIFACT_TYPE_NAME = "Root Artifact";
 
    public static Artifact getGlobalPreferenceArtifact() throws OseeCoreException {
       return getCachedArtifact(CoreArtifactTypes.GlobalPreferences, CoreArtifactTypes.GlobalPreferences.getName(),
@@ -39,7 +38,7 @@ public final class OseeSystemArtifacts {
    }
 
    public static Artifact getDefaultHierarchyRootArtifact(IOseeBranch branch) throws OseeCoreException {
-      return getCachedArtifact(CoreArtifactTypes.RootArtifact, DEFAULT_HIERARCHY_ROOT_NAME, branch);
+      return ArtifactQuery.getArtifactFromToken(CoreArtifactTokens.DefaultHierarchyRoot, branch);
    }
 
    public static Artifact createGlobalPreferenceArtifact() throws OseeCoreException {
diff --git a/plugins/org.eclipse.osee.framework.skynet.core/src/org/eclipse/osee/framework/skynet/core/artifact/UniversalGroup.java b/plugins/org.eclipse.osee.framework.skynet.core/src/org/eclipse/osee/framework/skynet/core/artifact/UniversalGroup.java
index 62bdad6be9d..67b65602488 100644
--- a/plugins/org.eclipse.osee.framework.skynet.core/src/org/eclipse/osee/framework/skynet/core/artifact/UniversalGroup.java
+++ b/plugins/org.eclipse.osee.framework.skynet.core/src/org/eclipse/osee/framework/skynet/core/artifact/UniversalGroup.java
@@ -16,12 +16,12 @@ import java.util.HashSet;
 import java.util.LinkedList;
 import java.util.logging.Level;
 import org.eclipse.osee.framework.core.data.IOseeBranch;
+import org.eclipse.osee.framework.core.enums.CoreArtifactTokens;
 import org.eclipse.osee.framework.core.enums.CoreArtifactTypes;
 import org.eclipse.osee.framework.core.enums.CoreRelationTypes;
 import org.eclipse.osee.framework.jdk.core.type.OseeArgumentException;
 import org.eclipse.osee.framework.jdk.core.type.OseeCoreException;
 import org.eclipse.osee.framework.logging.OseeLog;
-import org.eclipse.osee.framework.skynet.core.OseeSystemArtifacts;
 import org.eclipse.osee.framework.skynet.core.artifact.search.ArtifactQuery;
 import org.eclipse.osee.framework.skynet.core.internal.Activator;
 import org.eclipse.osee.framework.skynet.core.transaction.SkynetTransaction;
@@ -77,7 +77,6 @@ public class UniversalGroup {
    }
 
    public static Artifact getTopUniversalGroupArtifact(IOseeBranch branch) throws OseeCoreException {
-      return ArtifactQuery.getArtifactFromTypeAndName(CoreArtifactTypes.UniversalGroup,
-         OseeSystemArtifacts.ROOT_ARTIFACT_TYPE_NAME, branch);
+      return ArtifactQuery.getArtifactFromToken(CoreArtifactTokens.UniversalGroupRoot, branch);
    }
 }
\ No newline at end of file
diff --git a/plugins/org.eclipse.osee.framework.ui.skynet/src/org/eclipse/osee/framework/ui/skynet/widgets/XHyperlabelGroupSelection.java b/plugins/org.eclipse.osee.framework.ui.skynet/src/org/eclipse/osee/framework/ui/skynet/widgets/XHyperlabelGroupSelection.java
index 45a7573c362..3d02b26d76e 100644
--- a/plugins/org.eclipse.osee.framework.ui.skynet/src/org/eclipse/osee/framework/ui/skynet/widgets/XHyperlabelGroupSelection.java
+++ b/plugins/org.eclipse.osee.framework.ui.skynet/src/org/eclipse/osee/framework/ui/skynet/widgets/XHyperlabelGroupSelection.java
@@ -15,9 +15,9 @@ import java.util.Collection;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
+import org.eclipse.osee.framework.core.enums.CoreArtifactTypes;
 import org.eclipse.osee.framework.logging.OseeLevel;
 import org.eclipse.osee.framework.logging.OseeLog;
-import org.eclipse.osee.framework.skynet.core.OseeSystemArtifacts;
 import org.eclipse.osee.framework.skynet.core.artifact.Artifact;
 import org.eclipse.osee.framework.skynet.core.artifact.BranchManager;
 import org.eclipse.osee.framework.skynet.core.artifact.UniversalGroup;
@@ -82,7 +82,7 @@ public class XHyperlabelGroupSelection extends XHyperlinkLabelCmdValueSelection
    private Collection<Artifact> getGroups() {
       List<Artifact> groups = new ArrayList<Artifact>();
       for (Artifact art : UniversalGroup.getGroups(BranchManager.getCommonBranch())) {
-         if (!art.getName().equals(OseeSystemArtifacts.ROOT_ARTIFACT_TYPE_NAME)) {
+         if (!art.isOfType(CoreArtifactTypes.RootArtifact)) {
             groups.add(art);
          }
       }
diff --git a/plugins/org.eclipse.osee.orcs.core/src/org/eclipse/osee/orcs/core/internal/OrcsBranchImpl.java b/plugins/org.eclipse.osee.orcs.core/src/org/eclipse/osee/orcs/core/internal/OrcsBranchImpl.java
index 90e59686973..018668caf8e 100644
--- a/plugins/org.eclipse.osee.orcs.core/src/org/eclipse/osee/orcs/core/internal/OrcsBranchImpl.java
+++ b/plugins/org.eclipse.osee.orcs.core/src/org/eclipse/osee/orcs/core/internal/OrcsBranchImpl.java
@@ -157,4 +157,5 @@ public class OrcsBranchImpl implements OrcsBranch {
          branchDataFactory.createPortBranchData(branch, author, fromTransaction, associatedArtifact);
       return createBranch(branchData);
    }
+
 }
diff --git a/plugins/org.eclipse.osee.orcs.core/src/org/eclipse/osee/orcs/core/internal/search/ArtifactQueryBuilderImpl.java b/plugins/org.eclipse.osee.orcs.core/src/org/eclipse/osee/orcs/core/internal/search/ArtifactQueryBuilderImpl.java
index 01db2eb630f..e44b24ba8a1 100644
--- a/plugins/org.eclipse.osee.orcs.core/src/org/eclipse/osee/orcs/core/internal/search/ArtifactQueryBuilderImpl.java
+++ b/plugins/org.eclipse.osee.orcs.core/src/org/eclipse/osee/orcs/core/internal/search/ArtifactQueryBuilderImpl.java
@@ -19,6 +19,7 @@ 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.enums.CoreArtifactTokens;
 import org.eclipse.osee.framework.core.enums.CoreAttributeTypes;
 import org.eclipse.osee.framework.core.enums.QueryOption;
 import org.eclipse.osee.framework.jdk.core.type.Identifiable;
@@ -356,4 +357,11 @@ public class ArtifactQueryBuilderImpl<T> implements ArtifactQueryBuilder<T> {
       return queryData;
    }
 
+   @SuppressWarnings("unchecked")
+   @Override
+   public T andIsHeirarchicalRootArtifact() {
+      andIds(CoreArtifactTokens.DefaultHierarchyRoot);
+      return (T) this;
+   }
+
 }
diff --git a/plugins/org.eclipse.osee.orcs.rest/src/org/eclipse/osee/orcs/rest/internal/ArtifactsResource.java b/plugins/org.eclipse.osee.orcs.rest/src/org/eclipse/osee/orcs/rest/internal/ArtifactsResource.java
index 3d17b8cfe82..831366462b7 100644
--- a/plugins/org.eclipse.osee.orcs.rest/src/org/eclipse/osee/orcs/rest/internal/ArtifactsResource.java
+++ b/plugins/org.eclipse.osee.orcs.rest/src/org/eclipse/osee/orcs/rest/internal/ArtifactsResource.java
@@ -25,7 +25,6 @@ import org.eclipse.osee.framework.jdk.core.type.ResultSet;
 import org.eclipse.osee.orcs.OrcsApi;
 import org.eclipse.osee.orcs.data.ArtifactReadable;
 import org.eclipse.osee.orcs.rest.internal.search.artifact.ArtifactSearch_V1;
-import org.eclipse.osee.orcs.search.QueryFactory;
 
 /**
  * @author Roberto E. Escobar
@@ -64,14 +63,11 @@ public class ArtifactsResource {
    @Produces(MediaType.TEXT_HTML)
    public String getAsHtml() throws OseeCoreException {
       IOseeBranch branch = TokenFactory.createBranch(branchUuid, "");
-      QueryFactory factory = orcsApi.getQueryFactory(null);
-      ResultSet<ArtifactReadable> results =
-         factory.fromBranch(branch).andNameEquals(DEFAULT_HIERARCHY_ROOT_NAME).getResults();
-      ArtifactReadable rootArtifact = results.getExactlyOne();
+      ArtifactReadable rootArtifact =
+         orcsApi.getQueryFactory(null).fromBranch(branch).andIsHeirarchicalRootArtifact().getResults().getExactlyOne();
 
       ResultSet<ArtifactReadable> arts = rootArtifact.getChildren();
       HtmlWriter writer = new HtmlWriter(uriInfo);
       return writer.toHtml(arts);
    }
-   private static final String DEFAULT_HIERARCHY_ROOT_NAME = "Default Hierarchy Root";
 }
diff --git a/plugins/org.eclipse.osee.orcs/src/org/eclipse/osee/orcs/search/ArtifactQueryBuilder.java b/plugins/org.eclipse.osee.orcs/src/org/eclipse/osee/orcs/search/ArtifactQueryBuilder.java
index fb80da8415b..ac3bdb62951 100644
--- a/plugins/org.eclipse.osee.orcs/src/org/eclipse/osee/orcs/search/ArtifactQueryBuilder.java
+++ b/plugins/org.eclipse.osee.orcs/src/org/eclipse/osee/orcs/search/ArtifactQueryBuilder.java
@@ -213,4 +213,8 @@ public interface ArtifactQueryBuilder<T> {
     */
    T followRelation(IRelationTypeSide relationTypeSide);
 
+   /**
+    * @return DefaultHeirarchicalRootArtifact
+    */
+   T andIsHeirarchicalRootArtifact();
 }