Eclipse RSE Development Guide (Galileo) - IRSEPersistableReferencingObject (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.core.references
Interface IRSEPersistableReferencingObject

All Superinterfaces:: IRSEBasePersistableReferencingObject, IRSEBaseReferencingObject, IRSEReferencingObject

All Known Subinterfaces:: ISystemFilterPoolReference

public interface IRSEPersistableReferencingObject
extends IRSEReferencingObject, IRSEBasePersistableReferencingObject
extends IRSEReferencingObject, IRSEBasePersistableReferencingObject

A simple class that implements IRSEPersistableReferencingObject. This is an object that is a shadow (reference) of a real master object (IRSEPersistableReferencedObject).

Objects of this class contain a pointer (in memory) to the master object, and a copy of this object's unique name or key (for storing on disk).

Only the name is saved to disk, and after restoring from disk, that name is used to set the actual object reference.

The intention is that in your Rose model, your class extends this class. Do this for any shadow/reference class which you want to persist. Use a subclass of SystemPersistableReferenceManager to manage a list of these, and manage the saving/restoring of that list.

YOU MUST OVERRIDE resolveReferencesAfterRestore IN YOUR REFERENCE MANAGER SUBCLASS

Method Summary

IRSEBasePersistableReferenceManager getParentReferenceManager ()


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

void setParentReferenceManager ( IRSEBasePersistableReferenceManager value)


void setReferencedObjectName ( String value)


Methods inherited from interface org.eclipse.rse.core.references. IRSEBaseReferencingObject

getReferencedObject, isReferenceBroken, removeReference, setReferenceBroken, setReferencedObject

Methods inherited from interface org.eclipse.rse.core.references. IRSEBasePersistableReferencingObject

setReferencedObject

Methods inherited from interface org.eclipse.rse.core.references. IRSEBaseReferencingObject

getReferencedObject, isReferenceBroken, removeReference, setReferenceBroken, setReferencedObject

Method Detail

getReferencedObjectName


String getReferencedObjectName()

Description copied from interface: IRSEBasePersistableReferencingObject

Query the unique name or key of the object we are referencing.

Specified by:: getReferencedObjectName in interface IRSEBasePersistableReferencingObject

Returns:: The value of the ReferencedObjectName attribute

setReferencedObjectName

void setReferencedObjectName(
String value)

Parameters:: value - The new value of the ReferencedObjectName attribute

getParentReferenceManager


IRSEBasePersistableReferenceManager getParentReferenceManager()

Returns:: The ParentReferenceManager reference

setParentReferenceManager

void setParentReferenceManager(
IRSEBasePersistableReferenceManager value)

Parameters:: l - The new value of the ParentReferenceManager reference