Remote Systems
v6.4.1

com.ibm.etools.systems.filters
Interface SystemFilterContainerReference

All Known Subinterfaces:
SystemFilterPoolReference, SystemFilterReference
All Known Implementing Classes:
SystemFilterPoolReferenceImpl, SystemFilterReferenceImpl

public interface SystemFilterContainerReference

Both SystemFilter and SystemFilterPool contain filters, so the common methods for filters are abstracted out in SystemFilterContainer, which both classes implement. Both SystemFilterReference and SystemFilterPoolReference hold references to SystemFilterContainer objects (either SystemFilter or SystemFilterPool). There are a couple of methods that are common to both classes, related to getting an array of references to the filters that are held by the referenced object. This interface captures those common methods, and both SystemFilterReferenceImpl and SystemFilterPoolReferenceImpl implement this interface and hence these methods.

See Also:
SystemFilterContainerReferenceCommonMethods

Field Summary
static String copyright
           
 
Method Summary
 SystemFilterReference getExistingSystemFilterReference(SystemFilter filter)
          Return an existing reference to a given system filter.
 int getFilterCount()
          Return count of the number of filters in the referenced pool or filter
 String getName()
          Return the name of the SystemFilter or SystemFilterPool that we reference.
 SystemFilterContainer getReferencedSystemFilterContainer()
          Return the object to which we hold a reference.
 SystemFilterReference getSystemFilterReference(SystemFilter filter)
          Create a single filter refererence to a given filter If there already is a reference to this filter, it is returned.
 SystemFilterReference[] getSystemFilterReferences()
          Build and return an array of SystemFilterReference objects.
 boolean hasFilters()
          Return true if the referenced pool or filter has filters.
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Method Detail

getReferencedSystemFilterContainer

public SystemFilterContainer getReferencedSystemFilterContainer()
Return the object to which we hold a reference. This is either SystemFilter or SystemFilterPool. Since both implement SystemFilterContainer, that is what we return.


getSystemFilterReferences

public SystemFilterReference[] getSystemFilterReferences()
Build and return an array of SystemFilterReference objects. Each object is created new. There is one for each of the filters in the reference SystemFilter or SystemFilterPool. For performance reasons, we will cache this array and only return a fresh one if something changes in the underlying filter list.


getExistingSystemFilterReference

public SystemFilterReference getExistingSystemFilterReference(SystemFilter filter)
Return an existing reference to a given system filter. If no reference currently exists to this filter, returns null.

See Also:
getSystemFilterReference(SystemFilter)

getSystemFilterReference

public SystemFilterReference getSystemFilterReference(SystemFilter filter)
Create a single filter refererence to a given filter If there already is a reference to this filter, it is returned. If not, a new reference is created and appended to the end of the existing filter reference array.

See Also:
getExistingSystemFilterReference(SystemFilter)

getName

public String getName()
Return the name of the SystemFilter or SystemFilterPool that we reference. For such objects this is what we show in the GUI.


hasFilters

public boolean hasFilters()
Return true if the referenced pool or filter has filters.


getFilterCount

public int getFilterCount()
Return count of the number of filters in the referenced pool or filter


Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.