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 Returned Object (type, 
 * origin, value) to other ETA classes or allow other ETA classes to move,
 * or remove the Returned Object must implement this interface.
 */

// Author: Wesley Strickland
// Version History:
//   Nov 20, 2000 - comments/pseudocode added 
//   Nov 30, 2000 - (Mike Hebron) changed class description
//   Jun 12, 2001 - Mike Power added accessor methods and 

public interface ReturnedDataInterface
{
    /**
     * Returns the name describing the method that the value was
     * returned from
     * <p>
     * Pre-conditions: none
     * Post-conditions: none
     */
    public String getOriginName(); 

    /**
     * Returns the type of object contained in ReturnedData
     * <P>
     * Pre-conditions: none
     * Post-conditions: none
     */
    public String getTypeName(); 

    /**
     * returns the value, as type string, contained in ReturnedData
     * <P>
     * Pre-conditions: none
     * Post-conditions: none
     */
    public String getValue(); 

   /**
     * This method checks to see if ReturnedData is a primitive data type
     * <p>
     * Pre-conditions: none
     * Post-conditions: returns TRUE if value represented by this class is
     *                  is primitive
     *                  returns FALSE otherwise
    */
    public boolean isPrimitive();

      /**
     * This method invokes the ObjectInspector
     * <p>
     * Pre-conditions: none
     * Post-conditions: ObjectInspector is invoked on Object
     */
    public void inspectObjectValue();

    /**
     * This method moves the returned data to parameterData
     * <p>
     * Pre-conditions: none
     * Post-conditions: parameterData contains returnedData
     */
    public void move();


    /**
     * This method moves the returned data to parameterData
     * <p>
     * Pre-conditions: none
     * Post-conditions: returnedData removed from parameterData
     */
    public void remove();
}