Remote Systems
v6.4.1

com.ibm.etools.systems.references
Interface ISystemPersistableReferencedObject

All Superinterfaces:
ISystemReferencedObject
All Known Subinterfaces:
SystemFilterPool, SystemPersistableReferencedObject
All Known Implementing Classes:
SystemFilterPoolImpl, SystemPersistableReferencedObjectHelper, SystemPersistableReferencedObjectImpl

public interface ISystemPersistableReferencedObject
extends ISystemReferencedObject

Referenced objects are objects that have shadow objects of them. Typically, shadows are created to enable a GUI which does not allow the same real object to appear multiple times. In these cases, a unique shadow object is created for each unique instance of the real object.

The parent interface ISystemReferencedObject captures the simple set of methods an object that supports such a shadow must implement.

This interface specializes that for the case of objects which support references that must be persisted. Typically, we build the references in memory at runtime just to satisfy the GUI. 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 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.


Field Summary
static String copyright
           
 
Method Summary
 String getReferenceName()
          Query the unique name or key of this master object to record in the referencing object.
 
Methods inherited from interface com.ibm.etools.systems.references.ISystemReferencedObject
addReference, getReferenceCount, getReferencingObjects, removeAllReferences, removeReference
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Method Detail

getReferenceName

public String getReferenceName()
Query the unique name or key of this master object to record in the referencing object.


Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.