Attachment 36247 Details for Bug 131547 – Provider Interface

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Provider Interface

IDefectTrackingProvider.java (text/plain), 4.89 KB, created by Bianca Jiang

on 2006-03-14 11:47:08 EST

(hide)

Description:

Filename:

MIME Type:

Creator: Bianca Jiang

Created: 2006-03-14 11:47:08 EST

Size: 4.89 KB

patch

obsolete

>/*******************************************************************************
> * Copyright (c) 2006 IBM Corporation and others.
> * 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
> * $Id: TestLogViewer.java,v 1.6 2006/02/14 15:48:06 bjiang Exp $
> * 
> * Contributors:
> * IBM Corporation - initial API and implementation
> *******************************************************************************/
>package org.eclipse.hyades.test.ui.forms.extensions.provisional;
>
>import org.eclipse.hyades.models.common.testprofile.TPFExecutionEvent;
>import org.eclipse.hyades.models.common.testprofile.TPFExecutionResult;
>
>/**
> * This interface defines a defect tracking system provider that allows user to perform these functions: 
> * <li>create a connection with the defect repository</li>
> * <li>submit a new defect record (required)</li>
> * <li>open a existing defect record (optional)</li>
> * <li>query for existing defect records (optional)</li>
> * 
> * 
> * @see extension point "org.eclipse.hyades.test.ui.testLogDefectTrackingProvider"
> * @author bjiang
> * @since 4.2
> */
>public interface IDefectTrackingProvider {
>	
>	/**
>	 * Return any defect repository that already exist or an empty array if none existed yet. If there is
>	 * no repository information from the test log, they will be used for {@link #submitNewRecord(TPFExecutionEvent, TPFDefectRepository[])}
>	 * and {@link #findRecords(TPFExecutionEvent, TPFDefectRepository[])}. If there are repositories from 
>	 * test log, all of those repositories and repositories from this method will be used.
>	 * 
>	 * @see #submitNewRecord(TPFExecutionEvent, TPFDefectRepository[])
>	 * @see #findRecords(TPFExecutionEvent, TPFDefectRepository[])
>	 */
>	public TPFDefectRepository[] getDefectRepository();
>	
>	/**
>	 * This is where the action to submit a new record should be performed. This new record will be associated with
>	 * the specified executionEvent in the test log. If the specified repository array is
>	 * empty, it should let user to connect to a new defect repository first.
>	 * 
>	 * @param executionEvent
>	 * @param repository
>	 * @return the new defect record.
>	 */
>	public TPFDefectRecord submitNewRecord(TPFExecutionEvent executionEvent, TPFDefectRepository[] repository);
>	
>	/**
>	 * This is where the action to submit a new record should be performed. This new record will be associated with
>	 * the specified executionResult in the test log. If the specified repository array is
>	 * empty, it should let the user to connect to a new defect repository first.
>	 * 
>	 * @param executionEvent
>	 * @param repository
>	 * @return the new defect record.
>	 */
>	public TPFDefectRecord submitNewRecord(TPFExecutionResult executionResult, TPFDefectRepository[] repository);
>	
>	/**
>	 * Returns <code>true</code> if open defect record is supported. If not, the open record action will be disabled and
>	 * {@link #openRecord(TPFDefectRepository, String)} will never be called.
>	 */
>	public boolean isOpenRecordSupported();
>	
>	/**
>	 * Perform the action to open the defect record of the specified recordID with the specified defect respository.
>	 * 
>	 * @param repository
>	 * @param recordID
>	 */
>	public void openRecord(TPFDefectRepository repository, String recordID);
>	
>	/**
>	 * Returns <code>true</code> if query for existing defect records is supported. If not, the find existing record
>	 * function will be disabled and {@link #findRecords(TPFExecutionEvent, TPFDefectRepository[])} will not
>	 * be called.
>	 */
>	public boolean isQueryRecordSupported();
>	
>	/**
>	 * Performs the action to query for existing defect records for the specified executionEvent. The returned records
>	 * will be associated with the executionEvent.
>	 * 
>	 * @param executionEvent
>	 * @param repository
>	 * @return defect records to be associated with the specified executionEvent.
>	 * @see #isQueryRecordSupported()
>	 */
>	public TPFDefectRecord[] findRecords(TPFExecutionEvent executionEvent, TPFDefectRepository[] repository);
>	
>	/**
>	 * Performs the action to query for existing defect records for the specified executionResult. The returned records
>	 * will be associated with the executionEvent.
>	 * 
>	 * @param executionEvent
>	 * @param repository
>	 * @return defect records to be associated with the specified executionResult.
>	 * @see #isQueryRecordSupported()
>	 */
>	public TPFDefectRecord[] findRecords(TPFExecutionResult executionResult, TPFDefectRepository[] repository);
>
>	//public void RecordsRemoved(TPFExecutionEvent executionEvent, TPFDefectRecord[] recordID);
>	
>	//public void RecordsRemoved(TPFExecutionResult executionResult, TPFDefectRecord[] recordID);
>}

Actions: View

Attachments on bug 131547: 36235 | 36245 | 36247 | 36248 | 36249