/*
* org.openmicroscopy.shoola.agents.metadata.ScriptsLoader
*
*------------------------------------------------------------------------------
* Copyright (C) 2006-2010 University of Dundee. All rights reserved.
*
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
*------------------------------------------------------------------------------
*/
package org.openmicroscopy.shoola.agents.metadata;
//Java imports
import java.util.List;
//Third-party libraries
//Application-internal dependencies
import org.openmicroscopy.shoola.agents.metadata.editor.Editor;
import omero.gateway.SecurityContext;
import org.openmicroscopy.shoola.env.data.views.CallHandle;
/**
* Loads the scripts. This class calls the <code>loadScripts</code>
* method in the <code>MetadataHandlerView</code>.
*
* @author Jean-Marie Burel
* <a href="mailto:j.burel@dundee.ac.uk">j.burel@dundee.ac.uk</a>
* @author Donald MacDonald
* <a href="mailto:donald@lifesci.dundee.ac.uk">donald@lifesci.dundee.ac.uk</a>
* @version 3.0
* <small>
* (<b>Internal version:</b> $Revision: $Date: $)
* </small>
* @since 3.0-Beta4
*/
public class ScriptsLoader
extends EditorLoader
{
/** Handle to the asynchronous call so that we can cancel it. */
private CallHandle handle;
/**
* Flag indicating to load all the scripts (uploaded and default)
* or only the uploaded scripts.
*/
private boolean all;
/**
* Creates a new instance.
*
* @param viewer Reference to the viewer. Mustn't be <code>null</code>.
* @param ctx The security context.
* @param all Pass <code>true</code> to retrieve all the scripts uploaded
* ones and the default ones, <code>false</code>.
*/
public ScriptsLoader(Editor viewer, SecurityContext ctx, boolean all)
{
super(viewer, ctx);
this.all = all;
}
/**
* Loads the scripts.
* @see EditorLoader#load()
*/
public void load()
{
handle = mhView.loadScripts(ctx, -1, all, this);
}
/**
* Cancels the data loading.
* @see EditorLoader#cancel()
*/
public void cancel() { handle.cancel(); }
/**
* Feeds the result back to the viewer.
* @see EditorLoader#handleResult(Object)
*/
public void handleResult(Object result)
{
viewer.setScripts((List) result);
}
}