plugins/org.eclipse.osee.disposition.rest/src/org/eclipse/osee/disposition/rest/DispoApi.java

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

import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import org.eclipse.osee.disposition.model.CopySetParams;
import org.eclipse.osee.disposition.model.DispoAnnotationData;
import org.eclipse.osee.disposition.model.DispoConfig;
import org.eclipse.osee.disposition.model.DispoItem;
import org.eclipse.osee.disposition.model.DispoItemData;
import org.eclipse.osee.disposition.model.DispoSet;
import org.eclipse.osee.disposition.model.DispoSetData;
import org.eclipse.osee.disposition.model.DispoSetDescriptorData;
import org.eclipse.osee.framework.core.data.BranchId;
import org.eclipse.osee.framework.core.data.IOseeBranch;
import org.eclipse.osee.orcs.data.ArtifactReadable;

/**
 * @author Angel Avila
 */
public interface DispoApi {

   // Queries
   List<IOseeBranch> getDispoPrograms();

   List<DispoSet> getDispoSets(BranchId branch, String type);

   DispoSet getDispoSetById(BranchId branch, String dispoSetId);

   List<DispoItem> getDispoItems(BranchId branch, String dispoSetId, boolean isDetailed);

   DispoItem getDispoItemById(BranchId branch, String itemId);

   List<DispoAnnotationData> getDispoAnnotations(BranchId branch, String itemId);

   DispoAnnotationData getDispoAnnotationById(BranchId branch, String itemId, String annotationId);

   DispoConfig getDispoConfig(BranchId branch);

   DispoSet getDispoItemParentSet(BranchId branch, String itemId);

   // Writes
   Long createDispoProgram(String name);

   Long createDispoSet(BranchId branch, DispoSetDescriptorData descriptor);

   String createDispoAnnotation(BranchId branch, String itemId, DispoAnnotationData annotation, String userName);

   void editDispoSet(BranchId branch, String dispoSetId, DispoSetData newDispoSet);

   boolean editDispoItem(BranchId branch, String itemId, DispoItemData newDispoItem);

   boolean massEditTeam(BranchId branch, String setId, List<String> itemNames, String team, String commitMessage);

   boolean editDispoAnnotation(BranchId branch, String itemId, String annotationId, DispoAnnotationData newAnnotation, String userName);

   void copyDispoSet(BranchId branch, String destSetId, BranchId sourceBranch, String sourceSetId, CopySetParams params);

   void copyDispoSetCoverage(BranchId sourceBranch, Long sourceCoverageUuid, BranchId destBranch, String destSetId, CopySetParams params);

   // Deletes

   boolean deleteDispoSet(BranchId branch, String dispoSetId);

   boolean deleteDispoItem(BranchId branch, String itemId);

   boolean deleteDispoAnnotation(BranchId branch, String itemId, String annotationId, String userName);

   // Utilities
   boolean isUniqueProgramName(String name);

   boolean isUniqueSetName(BranchId branch, String setName);

   boolean isUniqueItemName(BranchId branch, String setId, String itemName);

   Collection<DispoItem> getDispoItemByAnnotationText(BranchId branch, String setId, String keyword, boolean isDetailed);

   DispoApiConfiguration getConfig();

   // CI
   HashMap<ArtifactReadable, BranchId> getCiSet(String ciSet);

   String getDispoItemId(BranchId branch, String setId, String item);

   boolean isCiSetConfigured(String ciSet);
}