org.olat.catalog.ui
Class CatalogController

java.lang.Object
  org.olat.core.gui.control.DefaultController
      org.olat.core.gui.control.controller.BasicController
          org.olat.catalog.ui.CatalogController

All Implemented Interfaces:

Controller, ControllerEventListener, Disposable, Activateable

public class CatalogController
extends BasicController
implements Activateable

 Description:
 

 The CatalogController is responsible for:
 

 
displaying the catalog with its categories and linked resources,
 starting from the supplied root node
 
handling the access to the actual category:
 

 
OLATAdmin is/should be the owner of catalog root
 
LocalTreeAdmin is administrator of a subtree within the catalog
 
Author is responsible for adding his resources to the catalog
 
ordinary user browses the catalog for quickly finding his desired
 resources
 
 The CatalogController accomplish this access rights by modifying the
 corresponding toolbox entries in the GUI, which grant access to the mentioned
 actions.
 
handles the controllers and forms allowing to edit, create the catalog
 structure
 

 
change category data (name, description)
 
modify category's localTreeAdmin group
 
contact category's localTreeAdmin group
 
add a new subcategory
 
add a resource link
 
remove a resource link
 
paste structure
 
 The OLATAdmin as superuser can invoke all of the above listed actions. 

 Whereas the LocalTreeAdmin is restricted to the follwing set: on the
 LocalTreeAdmin's subtree-root-node only 4,6 are possible. But from the
 children on he/she can invoke any of 1-6 except 5.

 The author is solely able to invoke 5.
 
 
 
 The catalog is based upon the idea of having a lot of resources which must
 somehow be ordered to find them quickly. Frankly speaking the catalog only
 makes sense if no access restrictions to the linked resources apply. This in
 mind, it is solely possible to link resources which are accessible for the
 users of the installation.
 

Date: 2005/10/14 12:35:40

Author:

Felix Jost

Constructor Summary

CatalogController(UserRequest ureq, WindowControl wControl, java.lang.String jumpToNode)
Init with catalog root

Method Summary

void	activate(UserRequest ureq, java.lang.String viewIdentifier) FIXME:pb:discussion FJ should we return boolean if activation was successful?
ToolController	createCatalogToolController() before calling this method make sure the person has the right to add categories.
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.DefaultController

addControllerListener, addLoggingResourceable, dispatchEvent, dispatchEvent, dispose, 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

CatalogController

public CatalogController(UserRequest ureq,
                         WindowControl wControl,
                         java.lang.String jumpToNode)

Init with catalog root

Parameters:

ureq -

wControl -

rootce -

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

See Also:

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

createCatalogToolController

public ToolController createCatalogToolController()

before calling this method make sure the person has the right to add categories. The method checks further if the person also can add links as author.

Returns:

configured tool controller

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)