Remote Systems
v6.4.1

com.ibm.etools.systems.filters
Interface SystemFilterPool

All Superinterfaces:
ISystemPersistableReferencedObject, ISystemReferencedObject, SystemFilterContainer, SystemPersistableReferencedObject, SystemReferencedObject
All Known Implementing Classes:
SystemFilterPoolImpl

public interface SystemFilterPool
extends SystemPersistableReferencedObject, SystemFilterContainer


Field Summary
static String copyright
           
 
Method Summary
 void cloneSystemFilterPool(SystemFilterPool targetPool)
          Clone this filter pools' attributes and filters into another filter pool.
 SystemFilter copySystemFilter(SystemFilterPool targetPool, SystemFilter oldFilter, String newName)
          Copy a system filter to this or another filter pool.
 EList getFilters()
           
 IFolder getFolder()
          Return the IFolder this pool is in
 String getName()
           
 SystemFilterNamingPolicy getNamingPolicy()
          Get the naming policy currently used when saving data to disk.
 String getOwningParentName()
          Returns the value of the 'Owning Parent Name' attribute
 SystemFilterPoolManagerProvider getProvider()
          Return the caller which instantiated the filter pool manager overseeing this filter framework instance
 int getRelease()
           
 Object getSystemFilterPoolData()
          Return transient data set via setFilterPoolData.
 SystemFilterPoolManager getSystemFilterPoolManager()
          Return the filter pool manager managing this collection of filter pools and their filters.
 String getType()
           
 boolean isDefault()
           
 boolean isDeletable()
           
 boolean isNonRenamable()
          Returns the value of the 'Non Renamable' attribute
 boolean isSetSingleFilterStringOnly()
          Returns whether the value of the 'Single Filter String Only' attribute is set
 boolean isSetStringsCaseSensitive()
           
 boolean isSingleFilterStringOnly()
          Returns the value of the 'Single Filter String Only' attribute
 boolean isStringsCaseSensitive()
           
 boolean isSupportsDuplicateFilterStrings()
           
 boolean isSupportsNestedFilters()
           
 void orderSystemFilters(String[] names)
          Order filters according to user preferences.
 void save()
          Save this filter pool to disk.
 void setDefault(boolean value)
           
 void setDeletable(boolean value)
           
 void setFolder(IFolder folder)
          Reset the IFolder this pool is in
 void setName(String value)
           
 void setNamingPolicy(SystemFilterNamingPolicy namingPolicy)
          Set the naming policy used when saving data to disk.
 void setNonRenamable(boolean value)
          Sets the value of the 'Non Renamable' attribute
 void setOwningParentName(String value)
          Sets the value of the 'Owning Parent Name' attribute
 void setRelease(int value)
           
 void setSavePolicy(int policy)
          Set the save file policy.
 void setSingleFilterStringOnly(boolean value)
          Sets the value of the 'Single Filter String Only' attribute
 void setStringsCaseSensitive(boolean value)
           
 void setSupportsDuplicateFilterStrings(boolean value)
           
 void setSupportsNestedFilters(boolean value)
           
 void setSystemFilterPoolData(Object data)
          This is to set transient data that is queryable via getFilterPoolData
 void setSystemFilterPoolManager(SystemFilterPoolManager mgr)
          Set the filter pool manager.
 void setType(String value)
           
 boolean supportsDuplicateFilterStrings()
          Does this support duplicate filter strings?
 boolean supportsNestedFilters()
          Does this filter support nested filters?
 void unsetSingleFilterStringOnly()
          Unsets the value of the 'Single Filter String Only' attribute
 void unsetStringsCaseSensitive()
           
 
Methods inherited from interface com.ibm.etools.systems.references.ISystemReferencedObject
addReference, getReferenceCount, getReferencingObjects, removeAllReferences, removeReference
 
Methods inherited from interface com.ibm.etools.systems.references.ISystemPersistableReferencedObject
getReferenceName
 
Methods inherited from interface com.ibm.etools.systems.filters.SystemFilterContainer
addSystemFilter, areStringsCaseSensitive, createSystemFilter, deleteSystemFilter, getSystemFilter, getSystemFilterCount, getSystemFilterNames, getSystemFilterPool, getSystemFilterPosition, getSystemFilters, getSystemFiltersVector, moveSystemFilter, renameSystemFilter, updateSystemFilter
 

Field Detail

copyright

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

getProvider

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


setNamingPolicy

public void setNamingPolicy(SystemFilterNamingPolicy namingPolicy)
Set the naming policy used when saving data to disk.

See Also:
SystemFilterNamingPolicy

getNamingPolicy

public SystemFilterNamingPolicy getNamingPolicy()
Get the naming policy currently used when saving data to disk.

See Also:
SystemFilterNamingPolicy

supportsNestedFilters

public boolean supportsNestedFilters()
Does this filter support nested filters?


supportsDuplicateFilterStrings

public boolean supportsDuplicateFilterStrings()
Does this support duplicate filter strings? Calls mof-generated isSupportsDuplicateFilterStrings.


isStringsCaseSensitive

public boolean isStringsCaseSensitive()
Returns:
The value of the StringsCaseSensitive attribute Are filter strings in this filter case sensitive? If not set locally, queries the parent filter pool manager's atttribute.

setSystemFilterPoolManager

public void setSystemFilterPoolManager(SystemFilterPoolManager mgr)
Set the filter pool manager.


getSystemFilterPoolManager

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

Specified by:
getSystemFilterPoolManager in interface SystemFilterContainer

setSystemFilterPoolData

public void setSystemFilterPoolData(Object data)
This is to set transient data that is queryable via getFilterPoolData


getSystemFilterPoolData

public Object getSystemFilterPoolData()
Return transient data set via setFilterPoolData.


cloneSystemFilterPool

public void cloneSystemFilterPool(SystemFilterPool targetPool)
                           throws Exception
Clone this filter pools' attributes and filters into another filter pool. Assumes the core attributes were already set when filter pool was created: Attributes we clone:

Throws:
Exception

copySystemFilter

public SystemFilter copySystemFilter(SystemFilterPool targetPool,
                                     SystemFilter oldFilter,
                                     String newName)
                              throws Exception
Copy a system filter to this or another filter pool.

Throws:
Exception

getFolder

public IFolder getFolder()
Return the IFolder this pool is in


orderSystemFilters

public void orderSystemFilters(String[] names)
Order filters according to user preferences.

While the framework has all the code necessary to arrange filters and save/restore that arrangement, you may choose to use preferences instead of this support. In this case, call this method and pass in the saved and sorted filter name list.

Called by someone after restore.


setFolder

public void setFolder(IFolder folder)
Reset the IFolder this pool is in


save

public void save()
          throws Exception
Save this filter pool to disk. Normally called by the filter pool manager.

Throws:
Exception

setSavePolicy

public void setSavePolicy(int policy)
Set the save file policy. See constants in SystemFilterConstants. One of: This method is called by the SystemFilterPoolManager.


getName

public String getName()
Returns:
The value of the Name attribute

setName

public void setName(String value)
Parameters:
value - The new value of the Name attribute

getType

public String getType()
Returns:
The value of the Type attribute Allows tools to have typed filter pools

setType

public void setType(String value)
Parameters:
value - The new value of the Type attribute

isSupportsNestedFilters

public boolean isSupportsNestedFilters()
Returns:
The value of the SupportsNestedFilters attribute

setSupportsNestedFilters

public void setSupportsNestedFilters(boolean value)
Parameters:
value - The new value of the SupportsNestedFilters attribute

isDeletable

public boolean isDeletable()
Returns:
The value of the Deletable attribute

setDeletable

public void setDeletable(boolean value)
Parameters:
value - The new value of the Deletable attribute

isDefault

public boolean isDefault()
Returns:
The value of the Default attribute Is this a default vendor-supplied pool versus user-created pool

setDefault

public void setDefault(boolean value)
Parameters:
value - The new value of the Default attribute

setStringsCaseSensitive

public void setStringsCaseSensitive(boolean value)
Parameters:
value - The new value of the StringsCaseSensitive attribute

unsetStringsCaseSensitive

public void unsetStringsCaseSensitive()

isSetStringsCaseSensitive

public boolean isSetStringsCaseSensitive()
Returns:
true if the StringsCaseSensitive attribute has been set

getFilters

public EList getFilters()
Returns:
The list of Filters references

isSupportsDuplicateFilterStrings

public boolean isSupportsDuplicateFilterStrings()
Returns:
The value of the SupportsDuplicateFilterStrings attribute

setSupportsDuplicateFilterStrings

public void setSupportsDuplicateFilterStrings(boolean value)
Parameters:
value - The new value of the SupportsDuplicateFilterStrings attribute

getRelease

public int getRelease()
Returns:
The value of the Release attribute In what release was this created? Typically, will be the version and release times 10, as in 40 or 51.

setRelease

public void setRelease(int value)
Parameters:
value - The new value of the Release attribute

isSingleFilterStringOnly

public boolean isSingleFilterStringOnly()
Returns the value of the 'Single Filter String Only' attribute.

If the meaning of the 'Single Filter String Only' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Single Filter String Only' attribute.
See Also:
isSetSingleFilterStringOnly(), unsetSingleFilterStringOnly(), setSingleFilterStringOnly(boolean), FiltersPackage.getSystemFilterPool_SingleFilterStringOnly()

setSingleFilterStringOnly

public void setSingleFilterStringOnly(boolean value)
Sets the value of the 'Single Filter String Only' attribute.

Parameters:
value - the new value of the 'Single Filter String Only' attribute.
See Also:
isSetSingleFilterStringOnly(), unsetSingleFilterStringOnly(), isSingleFilterStringOnly()

unsetSingleFilterStringOnly

public void unsetSingleFilterStringOnly()
Unsets the value of the 'Single Filter String Only' attribute.

See Also:
isSetSingleFilterStringOnly(), isSingleFilterStringOnly(), setSingleFilterStringOnly(boolean)

isSetSingleFilterStringOnly

public boolean isSetSingleFilterStringOnly()
Returns whether the value of the 'Single Filter String Only' attribute is set.

Returns:
whether the value of the 'Single Filter String Only' attribute is set.
See Also:
unsetSingleFilterStringOnly(), isSingleFilterStringOnly(), setSingleFilterStringOnly(boolean)

getOwningParentName

public String getOwningParentName()
Returns the value of the 'Owning Parent Name' attribute.

If the meaning of the 'Owning Parent Name' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Owning Parent Name' attribute.
See Also:
setOwningParentName(String), FiltersPackage.getSystemFilterPool_OwningParentName()

setOwningParentName

public void setOwningParentName(String value)
Sets the value of the 'Owning Parent Name' attribute.

Parameters:
value - the new value of the 'Owning Parent Name' attribute.
See Also:
getOwningParentName()

isNonRenamable

public boolean isNonRenamable()
Returns the value of the 'Non Renamable' attribute.

If the meaning of the 'Non Renamable' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Non Renamable' attribute.
See Also:
setNonRenamable(boolean), FiltersPackage.getSystemFilterPool_NonRenamable()

setNonRenamable

public void setNonRenamable(boolean value)
Sets the value of the 'Non Renamable' attribute.

Parameters:
value - the new value of the 'Non Renamable' attribute.
See Also:
isNonRenamable()

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.