Eclipse RSE Development Guide (Galileo) - ISystemFilterString (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 ISystemFilterString

All Superinterfaces:: IAdaptable, IPropertySetContainer, IRSEBaseReferencedObject, IRSEModelObject, IRSEPersistableContainer

public interface ISystemFilterString
extends IRSEBaseReferencedObject, IAdaptable, IRSEModelObject
extends IRSEBaseReferencedObject, IAdaptable, IRSEModelObject

A filter string is a pattern used by the server-side code to know what to return to the client. A filter contains one or more filter strings. Basically, its nothing more than a string, and its up to each consumer to know what to do with it. Generally, a filter string edit pane is designed to prompt the user for the contents of the string in a domain-friendly way.

Field Summary

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

NO_CHILDREN

Method Summary

void clone ( ISystemFilterString targetString)
          Clones this filter string's attributes into the given filter string

ISystemFilter getParentSystemFilter ()
          Get the parent filter that contains this filter string.

ISystemFilterPoolManagerProvider getProvider ()
          Return the caller which instantiated the filter pool manager overseeing this filter framework instance

String getString ()


ISystemFilterPoolManager getSystemFilterPoolManager ()
          Return the filter pool manager managing this collection of filter pools and their filters and their filter strings.

String getType ()
          Returns the type attribute.

boolean isChangable ()
          Check if this filter string is changeable.

boolean isDefault ()
          Check if this is a vendor-supplied filter string versus a user-defined filter string.

void setDefault (boolean value)


void setParentSystemFilter ( ISystemFilter filter)
          Set the transient parent back-pointer.

void setString ( String value)


void setType ( String value)


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

addReference, getReferenceCount, getReferencingObjects, removeAllReferences, removeReference

Methods inherited from interface org.eclipse.core.runtime. IAdaptable

getAdapter

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

getProvider


ISystemFilterPoolManagerProvider getProvider()

Return the caller which instantiated the filter pool manager overseeing this filter framework instance

getSystemFilterPoolManager


ISystemFilterPoolManager getSystemFilterPoolManager()

Return the filter pool manager managing this collection of filter pools and their filters and their filter strings.

setParentSystemFilter

void setParentSystemFilter(
ISystemFilter filter)

Set the transient parent back-pointer. Called by framework at restore/create time.

getParentSystemFilter


ISystemFilter getParentSystemFilter()

Get the parent filter that contains this filter string.

clone

void clone(
ISystemFilterString targetString)

Clones this filter string's attributes into the given filter string

isChangable

boolean isChangable()

Check if this filter string is changeable. Depends on attributes of parent filter.

getString


String getString()

Returns:: The value of the String attribute

setString

void setString(
String value)

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

getType


String getType()

Returns the type attribute. Intercepted to return SystemFilterConstants.DEFAULT_TYPE if it is currently null Allows tools to have typed filter strings

Returns:: The value of the Type attribute

setType

void setType(
String value)

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

isDefault

boolean isDefault()

Check if this is a vendor-supplied filter string versus a user-defined filter string.

Returns:: The value of the Default attribute

setDefault

void setDefault(boolean value)

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