package edu.calpoly.cpe205.fetter;
import javax.swing.*;
import java.util.*;
import java.io.*;
import java.lang.reflect.*;
import java.lang.*;
import java.awt.*;
import javax.swing.event.*;
import java.awt.event.*;

/**
 * Classes that want to provide information about a Test Data Item (type, 
 * name, value) to other ETA classes or allow other ETA classes to rename,
 * remove, or change the value of a Test Data Item must implement this
 * interface.
 */

// Author: Phillip Hansen
// Version History:
//   Nov 19, 2000 - comments/pseudocode added
//   Nov 30, 2000 - (Mike Hebron) updated class description

public interface ParameterDataInterface 
{
    /**
     *returns the user defined name for this ParameterData
     * <P>
     * Pre-condtions: none<BR>
     * Post-condtions: none
     */
    public String getDescriptiveName();

    /**
     * changes the name
     * <P>
     * Pre-conditions: none<BR>
     * Post-conditions: name has been changed
     * @param newName the new name
     */
    public void changeName(String newName);

    /**
     * shows the object inspector
     * <P>
     * Pre-conditions: none<BR>
     * Post-conditions: object inspector has been shown
     */
    public void inspectObjectValue();

    /**
     * changes the value
     * <P>
     * Pre-conditions: none<BR>
     * Post-conditions: value has been set to the new value
     * @param value the new value
     */
    public void changePrimitiveValue(String value);

    /**
     * removes the PrameterData
     * <P>
     * Pre-conditions: none<BR>
     * Post-conditions: the parameter data has been removed from the pool
     */
    public void remove();

    /**
     * returns the value
     * <P>
     * Pre-conditions: none<BR>
     * Post-conditions: none
     * @return String containing the value
     */
    public String getValue();

    /**
     * Determines if the data is primitive
     * <P>
     * Pre-conditions: none<BR>
     * Post-conditions: none
     * @return true if the data is primitive 
     */
    public boolean isPrimitive();

     /**
     * gets the name of the type
     * <P>
     * Pre-conditions: none<BR>
     * Post-conditions: none
     * @return the name of the type
     */
    public String toString();

    /**
     * returns the name of the type
     * <P>
     * Pre-conditions: none<BR>
     * Post-conditions: none
     * @returned String containing the name of the type
     */
    public String getTypeName();
}