Remote Systems
v6.4.1

com.ibm.etools.systems.filters
Interface SystemFilter

All Superinterfaces:
ISystemReferencedObject, SystemFilterContainer, SystemReferencedObject
All Known Implementing Classes:
SystemFilterImpl

public interface SystemFilter
extends SystemReferencedObject, SystemFilterContainer


Field Summary
static String copyright
           
 
Method Summary
 SystemFilterString addFilterString(String newString)
          Append a new filter string to this filter's list
 SystemFilterString addFilterString(String newString, int position)
          Insert a new filter string to this filter's list, at the given zero-based position
 void clone(SystemFilter targetFilter)
          Clones a given filter to the given target filter.
 SystemFilterString copySystemFilterString(SystemFilter targetFilter, SystemFilterString oldFilterString)
          Copies a given filter string from this filter to another filter in this pool or another pool in this manager or another manager.
 int getFilterStringCount()
          Get the number of filter strings this filter currently has
 Vector getFilterStringObjectsVector()
          Get this filter's filter strings as a Vector of FilterString objects
 String[] getFilterStrings()
          Get this filter's filter strings as an array
 Vector getFilterStringsVector()
          Get this filter's filter strings as a Vector of String objects
 String getName()
          Returns the value of the 'Name' attribute
 EList getNestedFilters()
          Returns the value of the 'Nested Filters' containment reference list.
 SystemFilter getParentFilter()
          Returns the value of the 'Parent Filter' container reference.
 SystemFilterContainer getParentFilterContainer()
          Return the ISystemFilterContainer parent of this filter.
 SystemFilterPool getParentFilterPool()
          Return the parent pool of this filter.
 SystemFilterPoolManagerProvider getProvider()
          Return the caller which instantiated the filter pool manager overseeing this filter framework instance
 int getRelativeOrder()
          Returns the value of the 'Relative Order' attribute
 int getRelease()
          Returns the value of the 'Release' attribute
 IFile getSaveFile()
          Return a handle to the file this filter is saved to.
 String getSaveFileName()
          Return the unqualified name of the file this filter is saved to.
 EList getStrings()
          Returns the value of the 'Strings' containment reference list.
 SystemFilterString getSystemFilterString(String string)
          Get a filter string given its string value
 SystemFilterString[] getSystemFilterStrings()
          Get this filter's filter string objects as an array
 String getType()
          Returns the value of the 'Type' attribute
 boolean isDefault()
          Returns the value of the 'Default' attribute
 boolean isNested()
          Return true if this filter is a nested filter or not.
 boolean isNonChangable()
          Returns the value of the 'Non Changable' attribute
 boolean isNonDeletable()
          Returns the value of the 'Non Deletable' attribute
 boolean isNonRenamable()
          Returns the value of the 'Non Renamable' attribute
 boolean isPromptable()
          Returns the value of the 'Promptable' attribute
 boolean isSetSingleFilterStringOnly()
          Returns whether the value of the 'Single Filter String Only' attribute is set
 boolean isSetStringsCaseSensitive()
          Returns whether the value of the 'Strings Case Sensitive' attribute is set
 boolean isSingleFilterStringOnly()
          Returns the value of the 'Single Filter String Only' attribute
 boolean isStringsCaseSensitive()
          Returns the value of the 'Strings Case Sensitive' attribute
 boolean isStringsNonChangable()
          Returns the value of the 'Strings Non Changable' attribute
 boolean isSupportsDuplicateFilterStrings()
          Returns the value of the 'Supports Duplicate Filter Strings' attribute
 boolean isSupportsNestedFilters()
          Returns the value of the 'Supports Nested Filters' attribute
 boolean isTransient()
          Return true if this a transient or simple filter that is only created temporary "on the fly" and not intended to be saved or part of the filter framework.
 void moveSystemFilterString(int pos, SystemFilterString filterString)
          Move a given filter string to a given zero-based location
 SystemFilterString removeFilterString(int position)
          Remove a filter string from this filter's list, given its zero-based position
 SystemFilterString removeFilterString(String oldString)
          Delete a filter string from this filter's list.
 boolean removeFilterString(SystemFilterString filterString)
          Remove a filter string from this filter's list, given its SystemFilterString object.
 void save()
          Attempt to save contents of filter to disk.
 void setDefault(boolean value)
          Sets the value of the 'Default' attribute
 void setFilterStrings(String[] strings)
          Set this filter's filter strings by giving an array of String objects
 void setFilterStrings(Vector strings)
          Set this filter's filter strings by giving a Vector of String objects
 void setName(String value)
          Sets the value of the 'Name' attribute
 void setNonChangable(boolean value)
          Sets the value of the 'Non Changable' attribute
 void setNonDeletable(boolean value)
          Sets the value of the 'Non Deletable' attribute
 void setNonRenamable(boolean value)
          Sets the value of the 'Non Renamable' attribute
 void setParentFilter(SystemFilter value)
          Sets the value of the 'Parent Filter' container reference
 void setParentFilterPool(SystemFilterPool parentPool)
          Internal use method to set the parent filter pool
 void setPromptable(boolean value)
          Sets the value of the 'Promptable' attribute
 void setRelativeOrder(int value)
          Sets the value of the 'Relative Order' attribute
 void setRelease(int value)
          Sets the value of the 'Release' attribute
 void setSingleFilterStringOnly(boolean value)
          Sets the value of the 'Single Filter String Only' attribute
 void setStringsCaseSensitive(boolean value)
          Sets the value of the 'Strings Case Sensitive' attribute
 void setStringsNonChangable(boolean value)
          Sets the value of the 'Strings Non Changable' attribute
 void setSupportsDuplicateFilterStrings(boolean value)
          Sets the value of the 'Supports Duplicate Filter Strings' attribute
 void setSupportsNestedFilters(boolean value)
          Sets the value of the 'Supports Nested Filters' attribute
 void setType(String value)
          Sets the value of the 'Type' attribute
 boolean supportsDuplicateFilterStrings()
          Does this support duplicate filter strings?
 void unsetSingleFilterStringOnly()
          Unsets the value of the 'Single Filter String Only' attribute
 void unsetStringsCaseSensitive()
          Unsets the value of the 'Strings Case Sensitive' attribute
 void updateFilterString(SystemFilterString filterString, String newValue)
          Update a new filter string's string value
 
Methods inherited from interface com.ibm.etools.systems.references.ISystemReferencedObject
addReference, getReferenceCount, getReferencingObjects, removeAllReferences, removeReference
 
Methods inherited from interface com.ibm.etools.systems.filters.SystemFilterContainer
addSystemFilter, areStringsCaseSensitive, createSystemFilter, deleteSystemFilter, getSystemFilter, getSystemFilterCount, getSystemFilterNames, getSystemFilterPool, getSystemFilterPoolManager, getSystemFilterPosition, getSystemFilters, getSystemFiltersVector, moveSystemFilter, renameSystemFilter, updateSystemFilter
 

Field Detail

copyright

public static final String copyright

See Also:
Constant Field Values
Method Detail

getName

public String getName()
Returns the value of the 'Name' attribute.

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

Returns:
the value of the 'Name' attribute.
See Also:
setName(String), FiltersPackage.getSystemFilter_Name()

setName

public void setName(String value)
Sets the value of the 'Name' attribute.

Parameters:
value - the new value of the 'Name' attribute.
See Also:
getName()

getType

public String getType()
Returns the value of the 'Type' attribute.

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

Returns:
the value of the 'Type' attribute.
See Also:
setType(String), FiltersPackage.getSystemFilter_Type()

setType

public void setType(String value)
Sets the value of the 'Type' attribute.

Parameters:
value - the new value of the 'Type' attribute.
See Also:
getType()

isSupportsNestedFilters

public boolean isSupportsNestedFilters()
Returns the value of the 'Supports Nested Filters' attribute.

If the meaning of the 'Supports Nested Filters' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Supports Nested Filters' attribute.
See Also:
setSupportsNestedFilters(boolean), FiltersPackage.getSystemFilter_SupportsNestedFilters()

setSupportsNestedFilters

public void setSupportsNestedFilters(boolean value)
Sets the value of the 'Supports Nested Filters' attribute.

Parameters:
value - the new value of the 'Supports Nested Filters' attribute.
See Also:
isSupportsNestedFilters()

getRelativeOrder

public int getRelativeOrder()
Returns the value of the 'Relative Order' attribute.

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

Returns:
the value of the 'Relative Order' attribute.
See Also:
setRelativeOrder(int), FiltersPackage.getSystemFilter_RelativeOrder()

setRelativeOrder

public void setRelativeOrder(int value)
Sets the value of the 'Relative Order' attribute.

Parameters:
value - the new value of the 'Relative Order' attribute.
See Also:
getRelativeOrder()

isDefault

public boolean isDefault()
Returns the value of the 'Default' attribute.

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

Returns:
the value of the 'Default' attribute.
See Also:
setDefault(boolean), FiltersPackage.getSystemFilter_Default()

setDefault

public void setDefault(boolean value)
Sets the value of the 'Default' attribute.

Parameters:
value - the new value of the 'Default' attribute.
See Also:
isDefault()

isStringsCaseSensitive

public boolean isStringsCaseSensitive()
Returns the value of the 'Strings Case Sensitive' attribute.

If the meaning of the 'Strings Case Sensitive' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Strings Case Sensitive' attribute.
See Also:
isSetStringsCaseSensitive(), unsetStringsCaseSensitive(), setStringsCaseSensitive(boolean), FiltersPackage.getSystemFilter_StringsCaseSensitive()

setStringsCaseSensitive

public void setStringsCaseSensitive(boolean value)
Sets the value of the 'Strings Case Sensitive' attribute.

Parameters:
value - the new value of the 'Strings Case Sensitive' attribute.
See Also:
isSetStringsCaseSensitive(), unsetStringsCaseSensitive(), isStringsCaseSensitive()

unsetStringsCaseSensitive

public void unsetStringsCaseSensitive()
Unsets the value of the 'Strings Case Sensitive' attribute.

See Also:
isSetStringsCaseSensitive(), isStringsCaseSensitive(), setStringsCaseSensitive(boolean)

isSetStringsCaseSensitive

public boolean isSetStringsCaseSensitive()
Returns whether the value of the 'Strings Case Sensitive' attribute is set.

Returns:
whether the value of the 'Strings Case Sensitive' attribute is set.
See Also:
unsetStringsCaseSensitive(), isStringsCaseSensitive(), setStringsCaseSensitive(boolean)

isPromptable

public boolean isPromptable()
Returns the value of the 'Promptable' attribute.

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

Returns:
the value of the 'Promptable' attribute.
See Also:
setPromptable(boolean), FiltersPackage.getSystemFilter_Promptable()

setPromptable

public void setPromptable(boolean value)
Sets the value of the 'Promptable' attribute.

Parameters:
value - the new value of the 'Promptable' attribute.
See Also:
isPromptable()

isSupportsDuplicateFilterStrings

public boolean isSupportsDuplicateFilterStrings()
Returns the value of the 'Supports Duplicate Filter Strings' attribute.

If the meaning of the 'Supports Duplicate Filter Strings' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Supports Duplicate Filter Strings' attribute.
See Also:
setSupportsDuplicateFilterStrings(boolean), FiltersPackage.getSystemFilter_SupportsDuplicateFilterStrings()

supportsDuplicateFilterStrings

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


setSupportsDuplicateFilterStrings

public void setSupportsDuplicateFilterStrings(boolean value)
Sets the value of the 'Supports Duplicate Filter Strings' attribute.

Parameters:
value - the new value of the 'Supports Duplicate Filter Strings' attribute.
See Also:
isSupportsDuplicateFilterStrings()

isNonDeletable

public boolean isNonDeletable()
Returns the value of the 'Non Deletable' attribute.

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

Returns:
the value of the 'Non Deletable' attribute.
See Also:
setNonDeletable(boolean), FiltersPackage.getSystemFilter_NonDeletable()

setNonDeletable

public void setNonDeletable(boolean value)
Sets the value of the 'Non Deletable' attribute.

Parameters:
value - the new value of the 'Non Deletable' attribute.
See Also:
isNonDeletable()

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.getSystemFilter_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()

isNonChangable

public boolean isNonChangable()
Returns the value of the 'Non Changable' attribute.

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

Returns:
the value of the 'Non Changable' attribute.
See Also:
setNonChangable(boolean), FiltersPackage.getSystemFilter_NonChangable()

setNonChangable

public void setNonChangable(boolean value)
Sets the value of the 'Non Changable' attribute.

Parameters:
value - the new value of the 'Non Changable' attribute.
See Also:
isNonChangable()

isStringsNonChangable

public boolean isStringsNonChangable()
Returns the value of the 'Strings Non Changable' attribute.

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

Returns:
the value of the 'Strings Non Changable' attribute.
See Also:
setStringsNonChangable(boolean), FiltersPackage.getSystemFilter_StringsNonChangable()

setStringsNonChangable

public void setStringsNonChangable(boolean value)
Sets the value of the 'Strings Non Changable' attribute.

Parameters:
value - the new value of the 'Strings Non Changable' attribute.
See Also:
isStringsNonChangable()

getRelease

public int getRelease()
Returns the value of the 'Release' attribute.

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

Returns:
the value of the 'Release' attribute.
See Also:
setRelease(int), FiltersPackage.getSystemFilter_Release()

setRelease

public void setRelease(int value)
Sets the value of the 'Release' attribute.

Parameters:
value - the new value of the 'Release' attribute.
See Also:
getRelease()

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.getSystemFilter_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)

getNestedFilters

public EList getNestedFilters()
Returns the value of the 'Nested Filters' containment reference list. The list contents are of type SystemFilter. It is bidirectional and its opposite is 'Parent Filter'.

If the meaning of the 'Nested Filters' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Nested Filters' containment reference list.
See Also:
FiltersPackage.getSystemFilter_NestedFilters(), getParentFilter()

getParentFilter

public SystemFilter getParentFilter()
Returns the value of the 'Parent Filter' container reference. It is bidirectional and its opposite is 'Nested Filters'.

If the meaning of the 'Parent Filter' container reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Parent Filter' container reference.
See Also:
setParentFilter(SystemFilter), FiltersPackage.getSystemFilter_ParentFilter(), getNestedFilters()

setParentFilter

public void setParentFilter(SystemFilter value)
Sets the value of the 'Parent Filter' container reference.

Parameters:
value - the new value of the 'Parent Filter' container reference.
See Also:
getParentFilter()

getStrings

public EList getStrings()
Returns the value of the 'Strings' containment reference list. The list contents are of type SystemFilterString.

If the meaning of the 'Strings' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Strings' containment reference list.
See Also:
FiltersPackage.getSystemFilter_Strings()

getParentFilterPool

public SystemFilterPool getParentFilterPool()
Return the parent pool of this filter. For nested filters, we walk up the parent chain until we find the pool.


setParentFilterPool

public void setParentFilterPool(SystemFilterPool parentPool)
Internal use method to set the parent filter pool


setFilterStrings

public void setFilterStrings(Vector strings)
Set this filter's filter strings by giving a Vector of String objects


setFilterStrings

public void setFilterStrings(String[] strings)
Set this filter's filter strings by giving an array of String objects


getFilterStringsVector

public Vector getFilterStringsVector()
Get this filter's filter strings as a Vector of String objects


getFilterStringObjectsVector

public Vector getFilterStringObjectsVector()
Get this filter's filter strings as a Vector of FilterString objects


getFilterStrings

public String[] getFilterStrings()
Get this filter's filter strings as an array


getSystemFilterStrings

public SystemFilterString[] getSystemFilterStrings()
Get this filter's filter string objects as an array


getFilterStringCount

public int getFilterStringCount()
Get the number of filter strings this filter currently has


getSystemFilterString

public SystemFilterString getSystemFilterString(String string)
Get a filter string given its string value


addFilterString

public SystemFilterString addFilterString(String newString)
Append a new filter string to this filter's list


addFilterString

public SystemFilterString addFilterString(String newString,
                                          int position)
Insert a new filter string to this filter's list, at the given zero-based position


updateFilterString

public void updateFilterString(SystemFilterString filterString,
                               String newValue)
Update a new filter string's string value


removeFilterString

public SystemFilterString removeFilterString(String oldString)
Delete a filter string from this filter's list.

Returns:
the SystemFilterString object deleted, or null if not found

removeFilterString

public SystemFilterString removeFilterString(int position)
Remove a filter string from this filter's list, given its zero-based position

Returns:
the SystemFilterString object deleted, or null if not found

removeFilterString

public boolean removeFilterString(SystemFilterString filterString)
Remove a filter string from this filter's list, given its SystemFilterString object.

Returns:
true if the given string existed and hence was deleted.

moveSystemFilterString

public void moveSystemFilterString(int pos,
                                   SystemFilterString filterString)
Move a given filter string to a given zero-based location


copySystemFilterString

public SystemFilterString copySystemFilterString(SystemFilter targetFilter,
                                                 SystemFilterString oldFilterString)
Copies a given filter string from this filter to another filter in this pool or another pool in this manager or another manager.


isNested

public boolean isNested()
Return true if this filter is a nested filter or not. If not, its parent is the filter pool.


isTransient

public boolean isTransient()
Return true if this a transient or simple filter that is only created temporary "on the fly" and not intended to be saved or part of the filter framework. Eg it has no manager or provider.

We always return false.

See Also:
SystemFilterSimpleImpl

clone

public void clone(SystemFilter targetFilter)
Clones a given filter to the given target filter. All filter strings, and all nested filters, are copied.

Parameters:
targetFilter - new filter into which we copy all our data

getParentFilterContainer

public SystemFilterContainer getParentFilterContainer()
Return the ISystemFilterContainer parent of this filter. Will be either a SystemFilterPool or a SystemFilter if this is a nested filter.


getProvider

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


getSaveFile

public IFile getSaveFile()
Return a handle to the file this filter is saved to.

Called by SystemFilterPoolManager on a rename or delete operation when the save policy is one file per filter.


getSaveFileName

public String getSaveFileName()
Return the unqualified name of the file this filter is saved to.

Called by SystemFilterPoolManager on a rename or delete operation when the save policy is one file per filter.


save

public void save()
          throws Exception
Attempt to save contents of filter to disk.

Throws:
Exception

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.