oracle.dss.persistence.gui
Interface PersistenceObjectFilter

All Known Implementing Classes:

BasicPersistenceObjectFilter

public interface PersistenceObjectFilter

Methods required for a filter that supports a way to limit the display of objects to display in a PersistenceObjectChooser.

See Also:

PersistenceObjectChooser.addPersistenceObjectFilter(oracle.dss.persistence.gui.PersistenceObjectFilter)

Method Summary

javax.swing.Icon	getDisplayIcon() Retrieves any icon that has been specified for this filter.
java.lang.String	getDisplayText() Retrieves the text that is displayed in this filter.
javax.naming.directory.Attributes	getMatchingAttributes() The attributes that identify the objects to choose from.
javax.naming.directory.SearchControls	getSearchControls() Retrieves the SearchControls that define the search filter.

Method Detail

getDisplayText

public java.lang.String getDisplayText()

Retrieves the text that is displayed in this filter.

Returns:

The text that this filter displays.

getDisplayIcon

public javax.swing.Icon getDisplayIcon()

Retrieves any icon that has been specified for this filter. If no icon has been set, then this method can return null.

Returns:

The icon that has been specified for this filter, or null.

getMatchingAttributes

public javax.naming.directory.Attributes getMatchingAttributes()

The attributes that identify the objects to choose from.

This is an optional method.

If both a filter expression and matching attributes specify the kinds of objects that should appear in the object chooser, then the objects that are specified in the filter expression should be displayed.

Returns:

The attributes that identify the objects to choose from.

getSearchControls

public javax.naming.directory.SearchControls getSearchControls()

Retrieves the SearchControls that define the search filter. Search controls provide users with fine control over the results that should be filtered.

This is an optional method.

Note that the search control is used in conjunction with the matching attributes. The objects identified by the matching attributes are further filtered by the search control.

Returns:

The search control that identifies the objects to choose from.

See Also:

SearchControls, BISearchControls