home *** CD-ROM | disk | FTP | other *** search
/ Programming Languages Suite / ProgLangD.iso / VCAFE.3.0A / Main.bin / PropertyInstanceGetter.java < prev    next >
Text File  |  1998-10-25  |  1KB  |  35 lines
  1. /*
  2.  * Copyright 1998 Symantec Corporation, All Rights Reserved.
  3.  */
  4.  
  5. package com.symantec.itools.vcafe.openapi;
  6.  
  7. /**
  8.  * The API used to get an Object Reference Property instance that correpsonds to the specified
  9.  * <code>VisualProperty</code> of the given <code>VisualObject</code>.
  10.  * If a plug-in is instantiating (via <code>VisualObject.instantiate</code>) a <code>VisualObject</code>
  11.  * that has <code>VisualProperties</code> that are designated as Object Reference Properties, the
  12.  * plug-in should provide an instance of <code>PropertyInstanceGetter</code> which returns the correct
  13.  * instances of the Object Reference Properties.
  14.  * @see VisualObject#instantiate
  15.  * @see VisualObject#updateInstanceProperty
  16.  *
  17.  * @author Symantec Internet Tools Division
  18.  * @version 1.0
  19.  * @since VCafe 3.0
  20.  */
  21.  
  22. public interface PropertyInstanceGetter {
  23.     /**
  24.      * Gets an instance of an Object Reference Property that corresponds to the
  25.      * <code>VisualProperty</code> of the given <code>VisualObject</code>.
  26.      * @param visualProperty    the VisualProperty whose ORP value to get.
  27.      * @param objectReferenced    the VisualObject that represents the ORP object.
  28.      * @return an Object Reference Property that corresponds to the specified java object property.
  29.      *
  30.      * @see VisualProperty#isObjectReferenceProperty
  31.      * @see VisualProperty#setReferencedVisualObjectID
  32.      */
  33.     Object getORPInstance(VisualProperty visualProperty, VisualObject objectReferenced);
  34. }
  35.