RSE
Release 3.2

org.eclipse.rse.core.filters
Interface ISystemFilterPoolManagerProvider

All Superinterfaces:
IAdaptable
All Known Subinterfaces:
IFileServiceSubSystemConfiguration, IProcessServiceSubSystemConfiguration, IRemoteCmdSubSystemConfiguration, IRemoteFileSubSystemConfiguration, IRemoteProcessSubSystemConfiguration, IShellServiceSubSystemConfiguration, ISubSystemConfiguration, ITerminalServiceSubSystemConfiguration
All Known Implementing Classes:
DStoreFileSubSystemConfiguration, DStoreProcessSubSystemConfiguration, DStoreShellSubSystemConfiguration, DStoreWindowsFileSubSystemConfiguration, FileServiceSubSystemConfiguration, FTPFileSubSystemConfiguration, LocalFileSubSystemConfiguration, LocalProcessSubSystemConfiguration, LocalShellSubSystemConfiguration, ProcessServiceSubSystemConfiguration, RemoteCmdSubSystemConfiguration, RemoteFileSubSystemConfiguration, RemoteProcessSubSystemConfiguration, SftpFileSubSystemConfiguration, ShellProcessSubSystemConfiguration, ShellServiceSubSystemConfiguration, SshShellSubSystemConfiguration, SshTerminalSubSystemConfiguration, SubSystemConfiguration, TelnetShellSubSystemConfiguration, TerminalServiceSubSystemConfiguration

public interface ISystemFilterPoolManagerProvider
extends IAdaptable

An interface for classes that instantiate SystemFilterPoolManager objects. This is the "caller" and as is recorded and recoverable from any object within the filter framework. This enables callers to get back instances of themselves given any filter object. Important when enabling UI actions against user selected filter framework objects

Further, the goal is the allow all the filter framework UI actions to work independently, able to fully handle all actions without intervention on the provider's part. However, often the provider needs to be informed of all events in order to fire events to update its GUI. So this interface captures those callbacks that done to the provider for every interesting event. Should you not care about these, supply empty shells for these methods.


Method Summary
 void filterEventFilterCreated(ISystemFilter newFilter)
          A new filter has been created
 void filterEventFilterDeleted(ISystemFilter oldFilter)
          A filter has been deleted
 void filterEventFilterPoolCreated(ISystemFilterPool newPool)
          A new filter pool has been created
 void filterEventFilterPoolDeleted(ISystemFilterPool oldPool)
          A filter pool has been deleted
 void filterEventFilterPoolRenamed(ISystemFilterPool pool, String oldName)
          A filter pool has been renamed
 void filterEventFilterPoolsRePositioned(ISystemFilterPool[] pools, int delta)
          One or more filter pools have been re-ordered within their manager
 void filterEventFilterRenamed(ISystemFilter filter, String oldName)
          A filter has been renamed
 void filterEventFiltersRePositioned(ISystemFilter[] filters, int delta)
          One or more filters have been re-ordered within their pool or filter (if nested)
 void filterEventFilterStringCreated(ISystemFilterString newFilterString)
          A new filter string has been created
 void filterEventFilterStringDeleted(ISystemFilterString oldFilterString)
          A filter string has been deleted
 void filterEventFilterStringsRePositioned(ISystemFilterString[] filterStrings, int delta)
          One or more filters have been re-ordered within their filter
 void filterEventFilterStringUpdated(ISystemFilterString filterString)
          A filter string has been updated
 void filterEventFilterUpdated(ISystemFilter filter)
          A filter's strings have been updated
 String getId()
          Return the unique id for this provider
 ISystemFilterPoolManager[] getReferencableSystemFilterPoolManagers(ISystemFilterPoolReferenceManager refMgr)
          Return all the manager objects this provider owns, to which it wants to support referencing from the given filter reference manager.
 ISystemFilterPool getSystemFilterPoolForBrokenReference(ISystemFilterPoolReferenceManager callingRefenceMgr, String missingPoolMgrName, String missingPoolName)
          Last chance call, by a filter pool reference manager, when a reference to a filter pool is found but the referenced master filter pool is not found in those the reference manager by getSystemFilterPoolManagers().
 ISystemFilterPoolManager getSystemFilterPoolManager(String managerName)
          Return the manager object for the given manager name.
 ISystemFilterPoolManager[] getSystemFilterPoolManagers()
          Return all the manager objects this provider owns
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Method Detail

getId

String getId()
Return the unique id for this provider

Returns:
the id

getSystemFilterPoolManager

ISystemFilterPoolManager getSystemFilterPoolManager(String managerName)
Return the manager object for the given manager name.


getSystemFilterPoolManagers

ISystemFilterPoolManager[] getSystemFilterPoolManagers()
Return all the manager objects this provider owns


getReferencableSystemFilterPoolManagers

ISystemFilterPoolManager[] getReferencableSystemFilterPoolManagers(ISystemFilterPoolReferenceManager refMgr)
Return all the manager objects this provider owns, to which it wants to support referencing from the given filter reference manager.

Called by SystemFilterPoolReferenceManager.


getSystemFilterPoolForBrokenReference

ISystemFilterPool getSystemFilterPoolForBrokenReference(ISystemFilterPoolReferenceManager callingRefenceMgr,
                                                        String missingPoolMgrName,
                                                        String missingPoolName)
Last chance call, by a filter pool reference manager, when a reference to a filter pool is found but the referenced master filter pool is not found in those the reference manager by getSystemFilterPoolManagers().

If this returns null, then this broken reference will be deleted


filterEventFilterPoolCreated

void filterEventFilterPoolCreated(ISystemFilterPool newPool)
A new filter pool has been created


filterEventFilterPoolDeleted

void filterEventFilterPoolDeleted(ISystemFilterPool oldPool)
A filter pool has been deleted


filterEventFilterPoolRenamed

void filterEventFilterPoolRenamed(ISystemFilterPool pool,
                                  String oldName)
A filter pool has been renamed


filterEventFilterPoolsRePositioned

void filterEventFilterPoolsRePositioned(ISystemFilterPool[] pools,
                                        int delta)
One or more filter pools have been re-ordered within their manager


filterEventFilterCreated

void filterEventFilterCreated(ISystemFilter newFilter)
A new filter has been created


filterEventFilterDeleted

void filterEventFilterDeleted(ISystemFilter oldFilter)
A filter has been deleted


filterEventFilterRenamed

void filterEventFilterRenamed(ISystemFilter filter,
                              String oldName)
A filter has been renamed


filterEventFilterUpdated

void filterEventFilterUpdated(ISystemFilter filter)
A filter's strings have been updated


filterEventFiltersRePositioned

void filterEventFiltersRePositioned(ISystemFilter[] filters,
                                    int delta)
One or more filters have been re-ordered within their pool or filter (if nested)


filterEventFilterStringCreated

void filterEventFilterStringCreated(ISystemFilterString newFilterString)
A new filter string has been created


filterEventFilterStringDeleted

void filterEventFilterStringDeleted(ISystemFilterString oldFilterString)
A filter string has been deleted


filterEventFilterStringUpdated

void filterEventFilterStringUpdated(ISystemFilterString filterString)
A filter string has been updated


filterEventFilterStringsRePositioned

void filterEventFilterStringsRePositioned(ISystemFilterString[] filterStrings,
                                          int delta)
One or more filters have been re-ordered within their filter


RSE
Release 3.2

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