Eclipse RSE Development Guide (Galileo) - ISystemFilterReference (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.filters
Interface ISystemFilterReference

All Superinterfaces:: IRSEBaseReferencingObject, IRSEReferencingObject, ISystemContainer, ISystemFilterContainerReference

All Known Implementing Classes:: SystemFilterReference

public interface ISystemFilterReference
extends IRSEReferencingObject, ISystemFilterContainerReference, ISystemContainer
extends IRSEReferencingObject, ISystemFilterContainerReference, ISystemContainer

Represents a shadow or reference to a system filter. Such references are only transient, not savable to disk.

Method Summary

ISystemFilterPoolReferenceManager getFilterPoolReferenceManager ()
          Return the reference manager which is managing this filter reference framework object.

ISystemFilterContainerReference getParent ()
          Get the parent of this reference.

ISystemFilterPoolReference getParentSystemFilterReferencePool ()
          Get parent or super parent filter pool reference.

ISystemFilterPoolReferenceManagerProvider getProvider ()
          Return the object which instantiated the pool reference manager object.

ISystemFilter getReferencedFilter ()
          Return the filter to which we reference...

ISubSystem getSubSystem ()
          Gets the subsystem that contains this reference

int getSystemFilterStringCount ()
          Return the number of filter strings in the referenced filter

ISystemFilterStringReference getSystemFilterStringReference ( ISystemFilterString filterString)
          Create a single filter string refererence to a given filter string

ISystemFilterStringReference[] getSystemFilterStringReferences ()
          Get the filter strings contained by this filter.

void setContents ( ISystemContentsType type, Object[] cachedContents)


void setReferencedFilter ( ISystemFilter filter)
          Set the filter to which we reference...

void setSubSystem ( ISubSystem subSystem)
          Sets the subsystem that contains this reference

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. ISystemContainer

getContents, hasContents, isStale, markStale, markStale

Method Detail

getFilterPoolReferenceManager


ISystemFilterPoolReferenceManager getFilterPoolReferenceManager()

Return the reference manager which is managing this filter reference framework object.

getProvider


ISystemFilterPoolReferenceManagerProvider getProvider()

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

getSubSystem


ISubSystem getSubSystem()

Gets the subsystem that contains this reference

Returns:: the subsystem

setSubSystem

void setSubSystem(
ISubSystem subSystem)

Sets the subsystem that contains this reference

Parameters:: subSystem - the subsystem that holds this reference

getReferencedFilter


ISystemFilter getReferencedFilter()

Return the filter to which we reference...

setReferencedFilter

void setReferencedFilter(
ISystemFilter filter)

Set the filter to which we reference...

getParent


ISystemFilterContainerReference getParent()

Get the parent of this reference. It will be either a SystemFilterPoolReference, or a SystemFilterReference(if nested).

getParentSystemFilterReferencePool


ISystemFilterPoolReference getParentSystemFilterReferencePool()

Get parent or super parent filter pool reference.

getSystemFilterStringCount

int getSystemFilterStringCount()

Return the number of filter strings in the referenced filter

getSystemFilterStringReferences


ISystemFilterStringReference[] getSystemFilterStringReferences()

Get the filter strings contained by this filter. But get references to each, not the masters.

getSystemFilterStringReference


ISystemFilterStringReference getSystemFilterStringReference(
ISystemFilterString filterString)

Create a single filter string refererence to a given filter string

setContents

void setContents(
ISystemContentsType type,
                 
Object[] cachedContents)