org.olat.repository.controllers
Class AddFileResourceController

java.lang.Object
  org.olat.core.gui.control.DefaultController
      org.olat.repository.controllers.AddFileResourceController

All Implemented Interfaces:

Controller, ControllerEventListener, Disposable, IAddController

public class AddFileResourceController
extends DefaultController
implements IAddController, ControllerEventListener

Responsability:

Offers to choose a file which is then added to the repository. Chooseable files can be restricted to specific file types.

Events fired:

No events are fired!
Signals are sent via RepositoryAddCallback

Workflow:

• Mainflow:
  Choose the file from a personal folder or upload one.
  Add file resource to repository.
  Signal success via finished(..)
• Failure:
  Wrong type of file or file creation failed.
  Signal failure via failure(..).
• Cancel:
  Choosing file is canceled
  Signal cancel via canceled(..)

Hints:

It is a special kind of controller as it uses the RepositoryAddCallback to signal state changes TODO:pb:a link to the doc book explaining how the repository is used.

Author:

Felix Jost

Constructor Summary

AddFileResourceController(RepositoryAddCallback addCallback, java.util.List limitTypes, java.lang.String[] suffixFilter, UserRequest ureq, WindowControl wControl)
Same as above, but able to restrict filetypes, this controller accepts.

AddFileResourceController(RepositoryAddCallback addCallback, java.util.List limitTypes, UserRequest ureq, WindowControl wControl)
Controller implementing "Repository Add"-workflow for all file resources.

Method Summary

void	event(UserRequest ureq, Component source, Event event) abstract event method for subclasses.
void	event(UserRequest urequest, Controller source, Event event) the only method of the interface controllereventlistener.
Component	getTransactionComponent() The transaction component which will be invoked by the repository add controller.
void	repositoryEntryCreated(RepositoryEntry re) Called after the repository entry has been created.
void	transactionAborted() Called if the repository aborts the transaction.
boolean	transactionFinishBeforeCreate() Called just before the repository entry gets created.

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.ControllerEventListener

dispatchEvent

Constructor Detail

AddFileResourceController

public AddFileResourceController(RepositoryAddCallback addCallback,
                                 java.util.List limitTypes,
                                 UserRequest ureq,
                                 WindowControl wControl)

Controller implementing "Repository Add"-workflow for all file resources.

Parameters:

addCallback - the channel to signal success, failure, cancel

limitTypes - may be null indicating no limits.

ureq -

wControl -

AddFileResourceController

public AddFileResourceController(RepositoryAddCallback addCallback,
                                 java.util.List limitTypes,
                                 java.lang.String[] suffixFilter,
                                 UserRequest ureq,
                                 WindowControl wControl)

Same as above, but able to restrict filetypes, this controller accepts.

Parameters:

addCallback - the channel to signal success, failure, cancel

limitTypes - may be null inidicating no limits.

suffixFilter - may be null for having no filter.

ureq -

wControl -

Method Detail

getTransactionComponent

public Component getTransactionComponent()

Description copied from interface: IAddController

The transaction component which will be invoked by the repository add controller. Controllers may return null here if the do not need a GUI-based workflow. However in such cases, they have to call addCallback.finished() at constructor time. (See AddCourseController for an example).

Specified by:

getTransactionComponent in interface IAddController

Returns:

Component implementing workflow.

See Also:

IAddController.getTransactionComponent()

transactionFinishBeforeCreate

public boolean transactionFinishBeforeCreate()

Description copied from interface: IAddController

Called just before the repository entry gets created.

Specified by:

transactionFinishBeforeCreate in interface IAddController

Returns:

true if transaction could successfully finished, false otherwise. I IAddController returns false, the repository entry will not be created.

See Also:

IAddController.transactionFinishBeforeCreate()

transactionAborted

public void transactionAborted()

Description copied from interface: IAddController

Called if the repository aborts the transaction. Do any cleanup work.

Specified by:

transactionAborted in interface IAddController

See Also:

IAddController.transactionAborted()

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 urequest,
                  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)

repositoryEntryCreated

public void repositoryEntryCreated(RepositoryEntry re)

Description copied from interface: IAddController

Called after the repository entry has been created.

Specified by:

repositoryEntryCreated in interface IAddController

See Also:

IAddController.repositoryEntryCreated(org.olat.repository.RepositoryEntry)