org.eclipse.rse.core.subsystems
Interface ISubSystem

All Superinterfaces:

IPropertySetContainer, IRemoteObjectResolver, IRSEModelObject, org.eclipse.rse.core.persistance.IRSEPersistableContainer, ISchedulingRule, ISystemFilterPoolReferenceManagerProvider

All Known Subinterfaces:

IFileServiceSubSystem, IProcessServiceSubSystem, IRemoteCmdSubSystem, IRemoteFileSubSystem, IRemoteProcessSubSystem, IServiceSubSystem, IShellServiceSubSystem

All Known Implementing Classes:

FileServiceSubSystem, ProcessServiceSubSystem, org.eclipse.rse.internal.subsystems.shells.subsystems.RemoteCmdSubSystem, RemoteFileSubSystem, RemoteProcessSubSystemImpl, ServiceSubSystem, ShellServiceSubSystem, SubSystem

public interface ISubSystem

extends ISystemFilterPoolReferenceManagerProvider, IRemoteObjectResolver, ISchedulingRule, IRSEModelObject, org.eclipse.rse.core.persistance.IRSEPersistableContainer

Interface implemented by SubSystem objects. While connections contain information to identify a particular remote system, it is the subsystem objects within a connection that contain information unique to a particular tool, for that remote system, such as the port the tool uses and the user ID for making the connection. There are a set of default properties, but these can be extended by subsystem providers, by extending SubSystem.

Method Summary

void	checkIsConnected() This is a helper method you can call when performing actions that must be certain there is a connection.
void	clearLocalUserId() Called to clear the local user Id such that subsequent requests to getUserId() will return the parent connection's default user Id.
void	connect() Connect to the remote system.
void	connect(boolean forcePrompt) Connect to the remote system, optionally forcing a signon prompt even if the password is cached in memory or on disk.
void	deletingConnection() Private method called when the parent connection is being deleted, so the subsystem can do any pre-death cleanup it needs to.
void	disconnect() Disconnect from the remote system.
void	disconnect(boolean collapseTree) Disconnect from the remote system.
boolean	doesFilterListContentsOf(ISystemFilter filter, String remoteObjectAbsoluteName) Return true if the given filter lists the contents of the given remote object.
boolean	doesFilterMatch(ISystemFilter filter, String remoteObjectAbsoluteName) Return true if the given remote object name will pass the filtering criteria for any of the filter strings in this filter.
boolean	doesFilterStringListContentsOf(ISystemFilterString filterString, String remoteObjectAbsoluteName) Return true if the given filter string lists the contents of the given remote object.
boolean	doesFilterStringMatch(String filterString, String remoteObjectAbsoluteName, boolean caseSensitive) Return true if the given remote object name will pass the filtering criteria for the given filter string in this filter.
boolean	forceUserIdToUpperCase() Return true if userId and password should be forced to uppercase.
ICacheManager	getCacheManager() Return the CacheManager for this subsystem.
Object[]	getChildren() Return the children for this subsystem.
String	getConfigurationId()
IConnectorService	getConnectorService() Return the IConnectorService object that represents the live connection for this system.
ISystemFilterPoolReferenceManager	getFilterPoolReferenceManager() Generated persistent property method Return the object that manages the list of filter pools referenced by this subsystem.
IHost	getHost() Return the connection object this subsystem is associated with.
String	getHostAliasName()
String	getLocalUserId() Alternative to getUserId when we don't want to resolve it from parent connection.
String	getName()
ISubSystem	getPrimarySubSystem() Return the primary subsystem associated with this subsystem's IConnectorService
String[]	getProperties(Object subject, String[] keys) Get a remote property.
String	getProperty(Object subject, String key) Get a remote property.
ISubSystemConfiguration	getSubSystemConfiguration() Return the parent subsystem factory that owns this subsystem.
ISystemFilterPoolReferenceManager	getSystemFilterPoolReferenceManager() Return the system filter pool reference manager, as per the interface SystemFilterPoolReferenceManagerProvider
ISystemProfile	getSystemProfile() Return the system profile object this subsystem is associated with.
String	getSystemProfileName()
Object	getTargetForFilter(ISystemFilterReference filterRef) Returns the parent object associated with a filter reference.
String	getUserId() Returns the value of this subsystem's user id if it is not null.
String	getVendorAttribute(String vendorName, String attributeName) For business partners defining their own subsystems.
boolean	hasChildren() Return true if this subsystem has children objects to be displayed in the Remote System View explorer.
void	initializeSubSystem(IProgressMonitor monitor) Called on each subsystem associated with a particular IConnectorService after it connects
boolean	isConnected() Return true if this subsystem is currently connected to its remote system.
boolean	isConnectionError() Return true if the last attempt to connect this subsystem to its remote system failed.
boolean	isHidden() Generated persistent property method Return true if this subsystem is to be hidden so it doesn't show in the Remote Systems view when a connection is expanded.
boolean	isOffline() Return true if this subsystem is currently being used in "offline" mode.
boolean	isPrimarySubSystem()
void	renamingConnection(String newName) Private method called when the parent connection is being renamed, so the subsystem can do any cleanup it needs to.
void	renamingProfile(String oldName, String newName) Private method called when the parent profile is being renamed, so the subsystem can do any cleanup it needs to.
Object[]	resolveFilterString(IProgressMonitor monitor, Object parent, String filterString) Modal thread version of resolve filter strings Resolve an absolute filter string.
Object[]	resolveFilterString(IProgressMonitor monitor, String filterString) Modal thread version of resolve filter strings Resolve an absolute filter string.
Object[]	resolveFilterString(Object parent, String filterString) Resolve an relative filter string.
Object[]	resolveFilterString(String filterString) Resolve an absolute filter string.
Object[]	resolveFilterStrings(IProgressMonitor monitor, String[] filterStrings) Modal thread version of resolve filter strings Resolve an absolute filter string.
Object[]	resolveFilterStrings(String[] filterStrings) Resolve multiple absolute filter strings.
void	setConfigurationId(String value)
void	setConnectionError(boolean error) Sets whether the last attempt to connect this subsystem to its remote system failed.
void	setConnectorService(IConnectorService connectorService) Set the connector service for this subsystem
void	setFilterPoolReferenceManager(ISystemFilterPoolReferenceManager value) Generated persistent property method Set the object that manages the list of filter pools referenced by this subsystem.
void	setHidden(boolean value) Generated persistent property method Specify true if this subsystem is to be hidden so it doesn't show in the Remote Systems view when a connection is expanded.
void	setHost(IHost conn) Set the parent connection that owns this subsystem.
void	setName(String value)
Object	setProperties(Object subject, String[] keys, String[] values) Set multiple remote properties.
Object	setProperty(Object subject, String key, String value) Set a remote property.
void	setSubSystemConfiguration(ISubSystemConfiguration ssf) Set the parent subsystem factory that owns this subsystem.
void	setVendorAttribute(String vendorName, String attributeName, String attributeValue) For business partners defining their own subsystems.
boolean	supportsCaching() Check if the SubSystem supports caching.
void	uninitializeSubSystem(IProgressMonitor monitor) Called on each subsystem associated with a particular IConnectorService after it disconnects

Methods inherited from interface org.eclipse.rse.core.filters.ISystemFilterPoolReferenceManagerProvider

filterEventFilterCreated, filterEventFilterPoolReferenceCreated, filterEventFilterPoolReferenceDeleted, filterEventFilterPoolReferenceRenamed, filterEventFilterPoolReferenceReset, filterEventFilterPoolReferencesRePositioned, filterEventFilterPoolReferencesReset, filterEventFilterStringCreated, getUniqueOwningSystemFilterPool

Methods inherited from interface org.eclipse.rse.core.subsystems.IRemoteObjectResolver

getObjectWithAbsoluteName

Methods inherited from interface org.eclipse.core.runtime.jobs.ISchedulingRule

contains, isConflicting

Methods inherited from interface org.eclipse.rse.core.model.IRSEModelObject

getDescription

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.persistance.IRSEPersistableContainer

commit, isDirty, setDirty, setWasRestored, wasRestored

Method Detail

getSubSystemConfiguration

public ISubSystemConfiguration getSubSystemConfiguration()

Return the parent subsystem factory that owns this subsystem.

setSubSystemConfiguration

public void setSubSystemConfiguration(ISubSystemConfiguration ssf)

Set the parent subsystem factory that owns this subsystem.

setHost

public void setHost(IHost conn)

Set the parent connection that owns this subsystem.

setConnectorService

public void setConnectorService(IConnectorService connectorService)

Set the connector service for this subsystem

Parameters:

connectorService -

getSystemProfile

public ISystemProfile getSystemProfile()

Return the system profile object this subsystem is associated with.

See Also:

getName()

getHost

public IHost getHost()

Return the connection object this subsystem is associated with.

initializeSubSystem

public void initializeSubSystem(IProgressMonitor monitor)

Called on each subsystem associated with a particular IConnectorService after it connects

uninitializeSubSystem

public void uninitializeSubSystem(IProgressMonitor monitor)

Called on each subsystem associated with a particular IConnectorService after it disconnects

isPrimarySubSystem

public boolean isPrimarySubSystem()

Returns:

true if this subsystem's properties should take precedence over other subsystems that share the same IConnectorService

getPrimarySubSystem

public ISubSystem getPrimarySubSystem()

Return the primary subsystem associated with this subsystem's IConnectorService

getHostAliasName

public String getHostAliasName()

Returns:

The name of the connection that owns this. Same as getSystemConnection().getAliasName()

getSystemProfileName

public String getSystemProfileName()

Returns:

The value of the profile that owns the connection that owns this subsystem. Fastpath.

renamingProfile

public void renamingProfile(String oldName,
                            String newName)

Private method called when the parent profile is being renamed, so the subsystem can do any cleanup it needs to. Called after the profile is actually renamed.

renamingConnection

public void renamingConnection(String newName)

Private method called when the parent connection is being renamed, so the subsystem can do any cleanup it needs to.

deletingConnection

public void deletingConnection()

Private method called when the parent connection is being deleted, so the subsystem can do any pre-death cleanup it needs to.

checkIsConnected

public void checkIsConnected()
                      throws SystemMessageException

This is a helper method you can call when performing actions that must be certain there is a connection. If there is no connection it will attempt to connect, and if that fails will throw a SystemMessageException you can easily display to the user by using a method in it.

Throws:

SystemMessageException

setVendorAttribute

public void setVendorAttribute(String vendorName,
                               String attributeName,
                               String attributeValue)

For business partners defining their own subsystems. This method allows an attribute to be persisted in this subsystem, given the following information:

• Vendor name. This name should uniquely differentiate one vendor's attributes from anothers.
• Attribute name. The name of the attribute to set.
• attribute value. The value to give the named attribute. It must be resolved into a string to use this. Eg, for boolean use something like "true" or "false". To clear the attribute value pass null for the value.

Warning do not use any of the following characters in any of given parameters, or it will cause problems with parsing:

• Pound sign ('#')
• Three underscores ("___")
• Three equals signs ("===")
• Three semicolons (";;;")

getVendorAttribute

public String getVendorAttribute(String vendorName,
                                 String attributeName)

For business partners defining their own subsystems. This method allows retrieval of a persisted attribute in this subsystem, given the following information:

• Vendor name. This name should uniquely differentiate one vendor's attributes from anothers.
• Attribute name. The name of the attribute whose value is being queried.

Returns:

value of the attribute being queried, or null if not found

forceUserIdToUpperCase

public boolean forceUserIdToUpperCase()

Return true if userId and password should be forced to uppercase. Shortcut to calling same method in parent SubSystemConfiguration.

getLocalUserId

public String getLocalUserId()

Alternative to getUserId when we don't want to resolve it from parent connection. This is used when showing the properties.

Unlike getUserId() this one does not defer to the connection's default user Id if the subsystem's userId attribute is null.

To set the local user Id, simply call setUserId(String id). To clear it, call clearLocalUserId().

See Also:

org.eclipse.rse.model.IHost#getDefaultUserId(), clearLocalUserId(), getUserId(), #setUserId(String)

clearLocalUserId

public void clearLocalUserId()

Called to clear the local user Id such that subsequent requests to getUserId() will return the parent connection's default user Id. Sets the user Id attribute for this subsystem to null.

See Also:

org.eclipse.rse.model.IHost#getDefaultUserId(), getUserId(), getLocalUserId(), #setUserId(String)

getChildren

public Object[] getChildren()

Return the children for this subsystem. This is used to populate the Remote System View explorer.

By default, if the parent subsystem factory supports filters, then we return getSystemFilterPoolReferencesArray. If filters are not supported (supportsFilters() returns false from factory) then we return null. In this case you should override this.

hasChildren

public boolean hasChildren()

Return true if this subsystem has children objects to be displayed in the Remote System View explorer.

doesFilterListContentsOf

public boolean doesFilterListContentsOf(ISystemFilter filter,
                                        String remoteObjectAbsoluteName)

Return true if the given filter lists the contents of the given remote object. For example, if given a folder, return true if any of the filter strings in this filter lists the contents of that folder. Used in impact analysis when a remote object is created, deleted, renamed, copied or moved, so as to establish which filters need to be refreshed or collapsed (if the folder is deleted, say).

The default algorithm calls doesFilterStringListContentsOf for each filter string.

doesFilterStringListContentsOf

public boolean doesFilterStringListContentsOf(ISystemFilterString filterString,
                                              String remoteObjectAbsoluteName)

Return true if the given filter string lists the contents of the given remote object. For example, if given a folder, return true if the given filter string lists the contents of that folder. Used in impact analysis when a remote object is created, deleted, renamed, copied or moved, so as to establish which filters need to be refreshed or collapsed (if the folder is deleted, say).

doesFilterMatch

public boolean doesFilterMatch(ISystemFilter filter,
                               String remoteObjectAbsoluteName)

Return true if the given remote object name will pass the filtering criteria for any of the filter strings in this filter.

doesFilterStringMatch

public boolean doesFilterStringMatch(String filterString,
                                     String remoteObjectAbsoluteName,
                                     boolean caseSensitive)

Return true if the given remote object name will pass the filtering criteria for the given filter string in this filter.

getSystemFilterPoolReferenceManager

public ISystemFilterPoolReferenceManager getSystemFilterPoolReferenceManager()

Return the system filter pool reference manager, as per the interface SystemFilterPoolReferenceManagerProvider

Specified by:

getSystemFilterPoolReferenceManager in interface ISystemFilterPoolReferenceManagerProvider

getName

public String getName()

Specified by:

getName in interface IRSEModelObject

Returns:

The value of the Name attribute

setName

public void setName(String value)

Parameters:

value - The new value of the Name attribute

getUserId

public String getUserId()

Returns the value of this subsystem's user id if it is not null. If it is null, it returns the parent connection object's default user Id.

In fact, we now don't store the user Id in the subsystem object itself, but rather store it in the user preferences, so that such things are not shared among the team on a synchronize operation. This is transparent to callers of this method however, as this method resolves from the preferences.

Returns:

The value of the UserId attribute

See Also:

org.eclipse.rse.model.IHost#getDefaultUserId(), #setUserId(String), getLocalUserId(), clearLocalUserId()

getConfigurationId

public String getConfigurationId()

Returns:

The value of the ConfigurationId attribute Ties this subsystem to its owning subsystem configuration, via the id key string of the configuration.

setConfigurationId

public void setConfigurationId(String value)

Parameters:

value - The new value of the ConfigurationId attribute

getConnectorService

public IConnectorService getConnectorService()

Return the IConnectorService object that represents the live connection for this system.

supportsCaching

public boolean supportsCaching()

Check if the SubSystem supports caching.

getCacheManager

public ICacheManager getCacheManager()

Return the CacheManager for this subsystem. If the SubSystem returns true for supportsCaching() then it must return a valid CacheManager, otherwise it is free to return null.

See Also:

supportsCaching()

isConnected

public boolean isConnected()

Return true if this subsystem is currently connected to its remote system.

isConnectionError

public boolean isConnectionError()

Return true if the last attempt to connect this subsystem to its remote system failed.

setConnectionError

public void setConnectionError(boolean error)

Sets whether the last attempt to connect this subsystem to its remote system failed.

isOffline

public boolean isOffline()

Return true if this subsystem is currently being used in "offline" mode. Not necessarily supported by all subsystems in which case this will always return false.

connect

public void connect()
             throws Exception

Connect to the remote system. Does not force a prompt for a password.

Throws:

Exception

connect

public void connect(boolean forcePrompt)
             throws Exception

Connect to the remote system, optionally forcing a signon prompt even if the password is cached in memory or on disk.

Parameters:

forcePrompt - forces the prompt dialog to be displayed even if the password is currently in memory.

Throws:

Exception

disconnect

public void disconnect()
                throws Exception

Disconnect from the remote system. In addition to calling getSystem().disconnect(),this must fire an event to collapse the expanded nodes in the tree under this node.

Throws:

Exception

disconnect

public void disconnect(boolean collapseTree)
                throws Exception

Disconnect from the remote system. In addition to calling getSystem().disconnect(),this may fire an event to collapse the expanded nodes in the tree under this node depending on the value of collapseTree.

Throws:

Exception

resolveFilterString

public Object[] resolveFilterString(IProgressMonitor monitor,
                                    String filterString)
                             throws Exception

Modal thread version of resolve filter strings Resolve an absolute filter string. This is only applicable if the subsystem factory reports true for supportsFilters().

When a user expands a filter containing filter strings, this method is invoked for each filter string.

The resulting objects are displayed in the remote system view tree. They can be anything, but at a minimum must support IAdaptable in order to drive the property sheet. You can just defer the getAdapter request to the platform's Adapter manager if desired.

You should supply an adapter class for the returned object's class, to render objects in the Remote System Explorer view. It will uses a label and content provider that defers all requests to the adapter, which it gets by querying the platform's adapter manager for the object type. Be sure to register your adapter factory.

Parameters:

monitor - the process monitor associated with this operation

filterString - filter pattern for objects to return.

Returns:

Array of objects that are the result of this filter string

Throws:

Exception

resolveFilterStrings

public Object[] resolveFilterStrings(IProgressMonitor monitor,
                                     String[] filterStrings)
                              throws Exception

Modal thread version of resolve filter strings Resolve an absolute filter string. This is only applicable if the subsystem factory reports true for supportsFilters().

When a user expands a filter containing filter strings, this method is invoked for each filter string.

The resulting objects are displayed in the remote system view tree. They can be anything, but at a minimum must support IAdaptable in order to drive the property sheet. You can just defer the getAdapter request to the platform's Adapter manager if desired.

You should supply an adapter class for the returned object's class, to render objects in the Remote System Explorer view. It will uses a label and content provider that defers all requests to the adapter, which it gets by querying the platform's adapter manager for the object type. Be sure to register your adapter factory.

Parameters:

monitor - the process monitor associated with this operation

filterStrings - filter patterns for objects to return.

Returns:

Array of objects that are the result of this filter string

Throws:

Exception

resolveFilterString

public Object[] resolveFilterString(IProgressMonitor monitor,
                                    Object parent,
                                    String filterString)
                             throws Exception

Modal thread version of resolve filter strings Resolve an absolute filter string. This is only applicable if the subsystem factory reports true for supportsFilters().

When a user expands a filter containing filter strings, this method is invoked for each filter string.

The resulting objects are displayed in the remote system view tree. They can be anything, but at a minimum must support IAdaptable in order to drive the property sheet. You can just defer the getAdapter request to the platform's Adapter manager if desired.

You should supply an adapter class for the returned object's class, to render objects in the Remote System Explorer view. It will uses a label and content provider that defers all requests to the adapter, which it gets by querying the platform's adapter manager for the object type. Be sure to register your adapter factory.

Parameters:

monitor - the process monitor associated with this operation

parent - the parent object to query

filterString - filter pattern for objects to return.

Returns:

Array of objects that are the result of this filter string

Throws:

Exception

resolveFilterString

public Object[] resolveFilterString(String filterString)
                             throws Exception

Resolve an absolute filter string. This is only applicable if the subsystem factory reports true for supportsFilters().

When a user expands a filter containing filter strings, this method is invoked for each filter string.

The resulting objects are displayed in the remote system view tree. They can be anything, but at a minimum must support IAdaptable in order to drive the property sheet. You can just defer the getAdapter request to the platform's Adapter manager if desired.

You should supply an adapter class for the returned object's class, to render objects in the Remote System Explorer view. It will uses a label and content provider that defers all requests to the adapter, which it gets by querying the platform's adapter manager for the object type. Be sure to register your adapter factory.

Parameters:

filterString - filter pattern for objects to return.

Returns:

Array of objects that are the result of this filter string

Throws:

Exception

resolveFilterStrings

public Object[] resolveFilterStrings(String[] filterStrings)
                              throws Exception

Resolve multiple absolute filter strings. This is only applicable if the subsystem factory reports true for supportsFilters().

This is the same as #resolveFilterString(String,Shell) but takes an array of filter strings versus a single filter string.

Parameters:

filterStrings - array of filter patterns for objects to return.

Returns:

Array of objects that are the result of resolving all the filter strings

Throws:

Exception

resolveFilterString

public Object[] resolveFilterString(Object parent,
                                    String filterString)
                             throws Exception

Resolve an relative filter string. This is only applicable if the subsystem factory reports true for supportsFilters().

When a user expands an object that came from a previous filter string expansion, (such as expanding a folder), this method is invoked to get the children of that object. The user can choose to expand all, or choose a pre-defined relative filter string to subset/filter the children. In either case, the relative filter string is passed in as well as the to-be-expanded parent object.

The resulting objects are displayed in the remote system view tree. They can be anything, but at a minimum must support IAdaptable in order to drive the property sheet. You can just defer the getAdapter request to the platform's Adapter manager if desired.

You should supply an adapter class for the returned object's class, to render objects in the Remote System Explorer view. It will uses a label and content provider that defers all requests to the adapter, which it gets by querying the platform's adapter manager for the object type. Be sure to register your adapter factory.

Parameters:

parent - Object that is being expanded.

filterString - filter pattern for children of parent.

Returns:

Array of objects that are the result of this filter string

Throws:

Exception

setProperty

public Object setProperty(Object subject,
                          String key,
                          String value)
                   throws Exception

Set a remote property. Subsystems interpret as they wish. Eg, this might be to set a remote environment variable. This is only applicable if the subsystem factory reports true for supportsProperties().

Parameters:

subject - Identifies which object to get the properties of

key - Identifies property to set

value - Value to set property to

Returns:

Object interpretable by subsystem. Might be a Boolean, or the might be new value for confirmation.

Throws:

Exception

getProperty

public String getProperty(Object subject,
                          String key)
                   throws Exception

Get a remote property. Subsystems interpret as they wish. Eg, this might be to get a remote environment variable. This is only applicable if the subsystem factory reports true for supportsProperties().

Parameters:

subject - Identifies which object to get the properties of

key - Identifies property to get value of

Returns:

String The value of the requested key.

Throws:

Exception

setProperties

public Object setProperties(Object subject,
                            String[] keys,
                            String[] values)
                     throws Exception

Set multiple remote properties. Subsystems interpret as they wish. Eg, this might be to set a number of remote environment variables. This is only applicable if the subsystem factory reports true for supportsProperties().

Parameters:

subject - Identifies which object to get the properties of

Returns:

Object interpretable by subsystem. Might be a Boolean, or the might be new values for confirmation.

Throws:

Exception

getProperties

public String[] getProperties(Object subject,
                              String[] keys)
                       throws Exception

Get a remote property. Subsystems interpret as they wish. Eg, this might be to get a remote environment variable. This is only applicable if the subsystem factory reports true for supportsProperties().

Parameters:

subject - Identifies which object to get the properties of

Returns:

Object The values of the requested keys.

Throws:

Exception

isHidden

public boolean isHidden()

Generated persistent property method
Return true if this subsystem is to be hidden so it doesn't show in the Remote Systems view when a connection is expanded. If so, this subsystem is for programmatic use only, or is exposed in alternative view. Such is the case for command subsystems, for example.

Returns:

The value of the Hidden attribute

setHidden

public void setHidden(boolean value)

Generated persistent property method
Specify true if this subsystem is to be hidden so it doesn't show in the Remote Systems view when a connection is expanded. If so, this subsystem is for programmatic use only, or is exposed in alternative view. Such is the case for command subsystems, for example.

Parameters:

value - The new value of the Hidden attribute

getFilterPoolReferenceManager

public ISystemFilterPoolReferenceManager getFilterPoolReferenceManager()

Generated persistent property method
Return the object that manages the list of filter pools referenced by this subsystem.

Returns:

The FilterPoolReferenceManager reference

setFilterPoolReferenceManager

public void setFilterPoolReferenceManager(ISystemFilterPoolReferenceManager value)

Generated persistent property method
Set the object that manages the list of filter pools referenced by this subsystem. This is called by the subsystem factory when creating or restoring subsystems.

getTargetForFilter

public Object getTargetForFilter(ISystemFilterReference filterRef)

Returns the parent object associated with a filter reference. It's up to the subsystem implementation to decide what "parent object" means for a filter reference.

Parameters:

filterRef - the filter reference to determine a target object from.

Returns: