* The parent interface IRSEReferencedObject captures the simple set of methods - * an object that supports such a shadow must implement. + * an object that supports such a real object implement. *
- * This interface specializes that for the case of objects which support references + * This interface specializes that for the case of real objects that support references * that must be persisted. - * Typically, we build the references in memory at runtime just to satisfy the GUI. + * Typically, we build the references in memory at runtime to satisfy the UI. * However, occassionally we build the list of references for a more permanent reason, * such as when we let a user choose a subset from a master list. *
* When we persist such a reference, we can't persist the memory reference to the master - * object. Instead, we persist the unique name or key of that object, and upon restoring + * object. Instead, we persist the unique name of that object, and upon restoring * from disk we then resolve that into a runtime reference to a real memory object. *
- * This interface captures the method to allow a shadow or referencing object to - * query that unique name or key from this referencable master object. + * This interface supplies the method to allow a referencing object to + * query that unique name or key from this real object. */ -public interface IRSEBasePersistableReferencedObject - extends IRSEBaseReferencedObject -{ - - /** - * Query the unique name or key of this master object to record in the referencing object. - */ - public String getReferenceName(); +public interface IRSEBasePersistableReferencedObject extends IRSEBaseReferencedObject { + + /** + * @return the unique name or key of this master object to record in the referencing object. + */ + public String getReferenceName(); } \ No newline at end of file