org.jboss.dependency.spi
Interface ControllerContext

All Superinterfaces:
Cloneable, org.jboss.util.JBossInterface
All Known Implementing Classes:
AbstractControllerContext

public interface ControllerContext
extends org.jboss.util.JBossInterface

Information about a context.

Version:
$Revision: 1.3 $
Author:
Adrian Brock

Method Summary
 Controller getController()
          Get the controller
 DependencyInfo getDependencyInfo()
          Get the dependency information
 Throwable getError()
          Get the error
 ControllerMode getMode()
          Get the mode
 Object getName()
          Get the name
 ControllerState getRequiredState()
          Get the required state
 ControllerState getState()
          Get the state
 Object getTarget()
          Get any target
 void install(ControllerState fromState, ControllerState toState)
          Install
 void setController(Controller controller)
          Set the controller
 void setError(Throwable error)
          Set the error
 void setMode(ControllerMode mode)
          Set the mode
 void setRequiredState(ControllerState state)
          Set the required state
 void uninstall(ControllerState fromState, ControllerState toState)
          Uninstall
 
Methods inherited from interface org.jboss.util.JBossInterface
clone, toShortString, toShortString
 

Method Detail

getName

public Object getName()
Get the name

Returns:
the name

getDependencyInfo

public DependencyInfo getDependencyInfo()
Get the dependency information

Returns:
the dependency information

getTarget

public Object getTarget()
Get any target

Returns:
the target

getController

public Controller getController()
Get the controller

Returns:
the controller

setController

public void setController(Controller controller)
Set the controller

Parameters:
controller - the controller

install

public void install(ControllerState fromState,
                    ControllerState toState)
             throws Throwable
Install

Parameters:
fromState - the old state
toState - the new state
Throws:
Throwable - for any error

uninstall

public void uninstall(ControllerState fromState,
                      ControllerState toState)
Uninstall

Parameters:
fromState - the old state
toState - the new state

getState

public ControllerState getState()
Get the state

Returns:
the state

getRequiredState

public ControllerState getRequiredState()
Get the required state

Returns:
the required state

setRequiredState

public void setRequiredState(ControllerState state)
Set the required state

Parameters:
state - the required state

getMode

public ControllerMode getMode()
Get the mode

Returns:
the mode

setMode

public void setMode(ControllerMode mode)
Set the mode

Parameters:
mode - the mode

getError

public Throwable getError()
Get the error

Returns:
the error

setError

public void setError(Throwable error)
Set the error

Parameters:
error - the error


Copyright © 2002 JBoss Group, LLC. All Rights Reserved.