com.novell.application.console.snapin
Interface ResultModifierSnapin

All Superinterfaces:

Help, Snapin

public interface ResultModifierSnapin

extends Snapin, Help

Provides a ResultModifier that describes the metrics the namespace uses to control the sorting and filtering of list and search operations.

Snap-ins must implement this interface to provide a custom ResultModifier that can be passed to the namespace's getChildren() and getChildContainers() methods. Normally, the implementation of the ResultModifierSnapin is a dialog which allows the user to specify sorting and filtering metrics specific to the namespace.

The ResultModifierSnapin is provided to allow namespaces to customize to data passed to getChildren() and getChildContainers().

Field Summary

static int	FILTER_GUI Defines the static final int used to indicate that a view filter GUI is being used to enter user input for a ResultModifier.
static int	SEARCH_GUI Defines the static final int used to indicate that a search GUI is being used to enter user input for a ResultModifier.
static int	UNKNOWN_GUI Defines the static final int used to indicate that an unknown GUI is being used to enter user input for a ResultModifier.

Method Summary

ResultModifier	buildResultModifier() Constructs a ResultModifer that describes sorting and filtering metrics that the namespace can use to perform list and search operations.
ObjectEntry	getCurrentContext() Returns the current object entry container to which the ResultModifer should be applied.
java.awt.Component	getUIComponent(ObjectEntry oe, ResultModifier resultModifier) Returns a Component that contains the UI used to enter the ResultModifer criteria.

Methods inherited from interface com.novell.application.console.snapin.Snapin

getSnapinDescription, getSnapinName, initSnapin, shutdownSnapin

Methods inherited from interface com.novell.application.console.snapin.Help

hasHelp, showHelp

Field Detail

UNKNOWN_GUI

public static final int UNKNOWN_GUI

Defines the static final int used to indicate that an unknown GUI is being used to enter user input for a ResultModifier.

(UNKNOWN_GUI = 0)

FILTER_GUI

public static final int FILTER_GUI

Defines the static final int used to indicate that a view filter GUI is being used to enter user input for a ResultModifier.

(FILTER_GUI = 1)

SEARCH_GUI

public static final int SEARCH_GUI

Defines the static final int used to indicate that a search GUI is being used to enter user input for a ResultModifier.

(SEARCH_GUI = 2)

Method Detail

getUIComponent

public java.awt.Component getUIComponent(ObjectEntry oe,
                                         ResultModifier resultModifier)

Returns a Component that contains the UI used to enter the ResultModifer criteria.

Parameters:

oe - An ObjectEntry providing the context for the method. If the method calls getObjectTypes(), it must have a context ObjectEntry.

resultModifier - A ResultModifier to be used to fill in the starting values for the UI. If null, defaults are used.

Returns:

The Component to be placed in a dialog pane.

See Also:

ResultModifier, NamespaceSnapin.getChildren(ObjectEntry parent, ResultModifier modifier), NamespaceSnapin.getChildContainers(ObjectEntry parent, ResultModifier modifier), NamespaceSnapin.getObjectTypes(ObjectEntry referenceContext)

buildResultModifier

public ResultModifier buildResultModifier()

Constructs a ResultModifer that describes sorting and filtering metrics that the namespace can use to perform list and search operations. The modifier is built from a user-input page provided to the shell by getPage() or programmatically.

Returns:

The ResultModifier to be used in subsequent getChildren() and getChildContainer() calls.

See Also:

ResultModifier, NamespaceSnapin.getChildren(ObjectEntry parent, ResultModifier modifier), NamespaceSnapin.getChildContainers(ObjectEntry parent, ResultModifier modifier), NamespaceSnapin.getObjectTypes(ObjectEntry referenceContext)

getCurrentContext

public ObjectEntry getCurrentContext()

Returns the current object entry container to which the ResultModifer should be applied.

Returns:

The container ObjectEntry to which the ResultModifier should be applied in subsequent getChildren() and getChildContainer() calls. If no context has been set by a call to getUIComponent(), return the current tree selection.

See Also:

ResultModifier, NamespaceSnapin.getChildren(ObjectEntry parent, ResultModifier modifier), NamespaceSnapin.getChildContainers(ObjectEntry parent, ResultModifier modifier), NamespaceSnapin.getObjectTypes(ObjectEntry referenceContext)