org.olat.home
Class HomeMainController

java.lang.Object
  org.olat.core.gui.control.DefaultController
      org.olat.core.gui.control.controller.BasicController
          org.olat.core.gui.control.controller.MainLayoutBasicController
              org.olat.home.HomeMainController

All Implemented Interfaces:

CustomCSSProvider, Controller, ControllerEventListener, Disposable, Activateable, MainLayoutController

public class HomeMainController
extends MainLayoutBasicController
implements Activateable

Responsability:

display the first page the user sees after she logged in successfully. This is the users individual dashboard within the learning management system.
The guest login has it's own first page !

Workflow:

• Mainflow:
  display portal.
• Portal editing:
  Switch portal to edit mode.
  edit portal.
  switch to display mode.
• Activate target XYZ:
  display activated component, i.e. jump to the personal briefcase

Activateable targets:

• MENU_ROOT:
  main entry point, the portal view.
• MENU_BC:
  jump to personal briefcase.
• MENU_NOTE:
  list of user notes.
• MENU_BOOKMARKS:
  users bookmarks list.
• MENU_ADMINNOTIFICATIONS:
  notifications list.
• MENU_OTHERUSERS:
  search other users workflow.
• MENU_EFFICIENCY_STATEMENTS:
  list of users efficency statements.

Hints:

TODO:fg:a add here the hints/special notes for the HomeMainController

Initial Date: Apr 27, 2004

Author:

Felix Jost

Constructor Summary

HomeMainController(UserRequest ureq, WindowControl wControl)
Constructor of the home main controller

Method Summary

void	activate(UserRequest ureq, java.lang.String viewIdentifier) FIXME:pb:discussion FJ should we return boolean if activation was successful?
void	event(UserRequest ureq, Component source, Event event) abstract event method for subclasses.
void	event(UserRequest ureq, Controller source, Event event) the only method of the interface controllereventlistener.

Methods inherited from class org.olat.core.gui.control.controller.MainLayoutBasicController

dispose, getCustomCSS, setCustomCSS

Methods inherited from class org.olat.core.gui.control.DefaultController

addControllerListener, addLoggingResourceable, dispatchEvent, dispatchEvent, getControllerCount, getInitialComponent, getUserActivityLogger, getWindowControlForDebug, isDisposed, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.olat.core.gui.control.Controller

addControllerListener, dispatchEvent, dispose, getInitialComponent, getUserActivityLogger, getWindowControlForDebug, isDisposed

Constructor Detail

HomeMainController

public HomeMainController(UserRequest ureq,
                          WindowControl wControl)

Constructor of the home main controller

Parameters:

ureq - The user request

wControl - The current window controller

Method Detail

event

public void event(UserRequest ureq,
                  Component source,
                  Event event)

Description copied from class: DefaultController

abstract event method for subclasses. the event received from the component we are listening to are always rerouted to this method here, except when the component has been disposed, in which case the events are simply ignored.

See Also:

DefaultController.event(org.olat.core.gui.UserRequest, org.olat.core.gui.components.Component, org.olat.core.gui.control.Event)

event

public void event(UserRequest ureq,
                  Controller source,
                  Event event)

Description copied from class: DefaultController

the only method of the interface controllereventlistener. always gets called when a controller we 'subscribed' to fires an event. we provide a default implementation here since there are many controllers which are standalone and need no subcontrollers

Parameters:

ureq -

source -

event -

activate

public void activate(UserRequest ureq,
                     java.lang.String viewIdentifier)

Description copied from interface: Activateable

FIXME:pb:discussion FJ should we return boolean if activation was successful?

Specified by:

activate in interface Activateable

See Also:

Activateable.activate(org.olat.core.gui.UserRequest, java.lang.String)