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.filters
Interface ISystemFilterPoolReference

All Superinterfaces:

IPropertySetContainer, IRSEBasePersistableReferencingObject, IRSEBaseReferencingObject, IRSEModelObject, IRSEPersistableContainer, IRSEPersistableReferencingObject, IRSEReferencingObject, ISystemFilterContainerReference

---

public interface ISystemFilterPoolReference
extends 
IRSEPersistableReferencingObject, 
ISystemFilterContainerReference, 
IRSEModelObject

Interface implemented by references to filter pools. Filter pools are stored at the profile level, while subsystems contain references to one or more pools. A pool can be referenced by multiple connections. Pools don't go away until explicitly deleted by the user, regardless of their reference count.

---

Field Summary

 

Fields inherited from interface org.eclipse.rse.core.model. IRSEPersistableContainer
NO_CHILDREN

 

Method Summary
ISystemFilterPoolReferenceManager	getFilterPoolReferenceManager ()
String	getFullName ()
ISystemFilterPoolReferenceManagerProvider	getProvider ()
ISystemFilterPool	getReferencedFilterPool ()
String	getReferencedFilterPoolManagerName ()
String	getReferencedFilterPoolName ()
void	resetReferencedFilterPoolName ( String newName)           Reset the name of the filter pool we reference.
void	setReferenceToFilterPool ( ISystemFilterPool pool)           Set the filter pool that we reference.

 

Methods inherited from interface org.eclipse.rse.core.references. IRSEPersistableReferencingObject
getParentReferenceManager, getReferencedObjectName, setParentReferenceManager, setReferencedObjectName

 

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

 

Methods inherited from interface org.eclipse.rse.core.filters. ISystemFilterContainerReference
getExistingSystemFilterReference, getFilterCount, getName, getReferencedSystemFilterContainer, getSystemFilterReference, getSystemFilterReferences, hasFilters

 

Methods inherited from interface org.eclipse.rse.core.model. IRSEModelObject
getDescription, getName

 

Methods inherited from interface org.eclipse.rse.core.model. IPropertySetContainer
addPropertySet, addPropertySets, createPropertySet, createPropertySet, getPropertySet, getPropertySets, removePropertySet

 

Methods inherited from interface org.eclipse.rse.core.model. IRSEPersistableContainer
commit, getPersistableChildren, getPersistableParent, isDirty, isTainted, setDirty, setTainted, setWasRestored, wasRestored

 

Method Detail

getFilterPoolReferenceManager

ISystemFilterPoolReferenceManager getFilterPoolReferenceManager()

Returns:

the reference manager which is managing this filter pool reference

---

getProvider

ISystemFilterPoolReferenceManagerProvider getProvider()

Returns:

the object which instantiated the pool reference manager object. Makes it easy to get back to the point of origin, given any filter pool reference.

---

getReferencedFilterPoolName

String getReferencedFilterPoolName()

Returns:

the simple name of the filter pool we reference. Not qualified by the manager name.

---

getReferencedFilterPoolManagerName

String getReferencedFilterPoolManagerName()

Returns:

name of the filter pool manager containing the pool we reference.

---

resetReferencedFilterPoolName

void resetReferencedFilterPoolName(
String newName)

Reset the name of the filter pool we reference. Called on filter pool rename operations.

Parameters:

newName - the new name of the filer pool

---

setReferenceToFilterPool

void setReferenceToFilterPool(
ISystemFilterPool pool)

Set the filter pool that we reference. This should also call addReference(this) on that pool.

Parameters:

pool - the pool to which this reference refers.

---

getReferencedFilterPool

ISystemFilterPool getReferencedFilterPool()

Returns:

referenced filter pool object. This may be null if the reference is broken or is yet to be resolved.

---

getFullName

String getFullName()

Returns:

the fully qualified name that includes the name of the filter pool manager

---

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

---

Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.