com.ibm.as400.opnav
Interface FilteringListManager
- All Known Implementing Classes:
- NativeListManager
- public interface FilteringListManager
The interface which indicates that a ListManager
implementation
supports filtering of a list through specification of predefined include criteria.
FilteringListManager
should be implemented
by the same class that implements ListManager
. If a plug-in's
ListManager
implementation is found to be assignable to
FilteringListManager
, it is assumed that the implementation
supports the setting of include criteria which take effect on the next
call to open
.
When the user interface needs to provide an indication of how the
list has been filtered, getFilterDescription
is called
to obtain a text string suitable for display to users.
User interface assumptions:
- There are always lists of system objects to be managed.
- Objects in a list are represented as rows in a table.
Objects always have a name, and an image (icon). An object
may define any number of additional table columns which are
specific to the object type.
- Since each list may have unique include criteria, it
is generally not possible to define a single, common user interface
for letting users specify how they wish to filter the list.
Implementation assumptions: None.
- Since:
- v5r1m0
- See Also:
ListManager
Method Summary |
java.lang.String |
getFilterDescription()
Returns a text description of the current include criteria. |
getFilterDescription
public java.lang.String getFilterDescription()
- Returns a text description of the current include criteria.
This method is called when the user interface needs to
provide an indication that the list has been filtered.
The returned string should describe the include criteria
currently in effect, and should be in a form suitable for
displaying to the user.
- Returns:
- the text description of the current include criteria.
- Since:
- v5r1m0