Remote Systems
v6.4.1

com.ibm.etools.systems.references
Interface ISystemPersistableReferencingObject

All Superinterfaces:
ISystemReferencingObject
All Known Subinterfaces:
SystemFilterPoolReference, SystemPersistableReferencingObject
All Known Implementing Classes:
SystemFilterPoolReferenceImpl, SystemPersistableReferencingObjectImpl

public interface ISystemPersistableReferencingObject
extends ISystemReferencingObject

Referencing objects are shadows of real objects. 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 ISystemReferencingObject captures the simple set of methods such a shadow must implement.

This interface specializes that for the case of 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 methods to set and query that name or key.


Field Summary
static String copyright
           
 
Method Summary
 String getReferencedObjectName()
          Query the unique name or key of the object we are referencing.
 void setReferencedObject(ISystemPersistableReferencedObject obj)
          Set the object to which we reference.
 
Methods inherited from interface com.ibm.etools.systems.references.ISystemReferencingObject
getReferencedObject, isReferenceBroken, removeReference, setReferenceBroken, setReferencedObject
 

Field Detail

copyright

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

setReferencedObject

public void setReferencedObject(ISystemPersistableReferencedObject obj)
Set the object to which we reference. This is an overload of the parent interface method of the same name. This one takes an object of which we can query its unique name for the purpose of saving that to disk.


getReferencedObjectName

public String getReferencedObjectName()
Query the unique name or key of the object we are referencing.


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.