com.novell.application.console.snapin.context
Class ResultModifierSnapinContext

java.lang.Object
  |
  +--com.novell.application.console.snapin.context.SnapinContext
        |
        +--com.novell.application.console.snapin.context.ResultModifierSnapinContext

public class ResultModifierSnapinContext

extends SnapinContext

Contains:

An indication of which Graphical User Interface the Shell is going to use the ResultModifierSnapin's component on. For example, if the Shell is going to place the returned component on a Filter dialog, then ResultModifier.FILTER_GUI is indicated.

A user defined Object which can represent any complex object that collaborating snapins may want to pass the the ResultModifierSnapin. This object may be used to indicate initial state to the ResultModifierSnapin.

The ResultModifierSnapinContext object is passed to the ResultModifierSnapin on initialization through the InitSnapinInfo parameter to the initSnapin() method. The ResultModifierSnapinContext can be retrieved from the InitSnapinInfo parameter with a call to the getSnapinContext() method.

See Also:

SnapinContext, ResultModifierSnapin

Field Summary

protected java.awt.Window	m_parentWindow
protected java.lang.Object	m_userObject

Method Summary

int	getGuiType() Retrieves the Graphical User Interface (gui) indicator from the context.
java.awt.Window	getParentWindow() Retrieves the parent window on which the gui component will be placed from the context.
java.lang.Object	getUserObject() Retrieves the user Object from the context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_userObject

protected java.lang.Object m_userObject

m_parentWindow

protected java.awt.Window m_parentWindow

Method Detail

getGuiType

public int getGuiType()

Retrieves the Graphical User Interface (gui) indicator from the context.

Returns:

The Graphical User Interface (gui) indicator associated with the ResultModifierSnapinContext.

getUserObject

public java.lang.Object getUserObject()

Retrieves the user Object from the context.

Returns:

The user Object associated with the ResultModifierSnapinContext.

getParentWindow

public java.awt.Window getParentWindow()

Retrieves the parent window on which the gui component will be placed from the context.

Returns:

The parent window associated with the ResultModifierSnapinContext.