LearnPAd/learnpad

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package eu.learnpad.cw;

import java.util.Collection;

import javax.ws.rs.PathParam;

import org.xwiki.component.annotation.Role;

import eu.learnpad.cw.rest.data.ScoreRecordCollection;
import eu.learnpad.exception.LpRestException;
import eu.learnpad.or.rest.data.Recommendations;
import eu.learnpad.sim.rest.data.ProcessInstanceData;

@Role
public interface UICWBridge {

    public Recommendations getRecommendations(String modelSetId, String artifactId, String userId)
            throws LpRestException;

    public String getDashboardKpiDefaultViewer(String modelSetId, String userId) throws LpRestException;

    public String startDashboardKpiCalculation(String modelSetId) throws LpRestException;

    public String getRestPrefix(String component) throws LpRestException;

    public String startSimulation(String modelId, String currentUser, Collection<String> potentialUsers)
            throws LpRestException;

    public String joinSimulation(String simulationId, String userId) throws LpRestException;

    public Collection<String> listSimulations() throws LpRestException;

    public ProcessInstanceData getSimulationInfo(@PathParam("simulationid") String simulationId) throws LpRestException;

    public ScoreRecordCollection getScores(String userid, String modelid) throws LpRestException;

    public void pageNotification(String modelSetId, String modelId, String artifactId, String resourceId, String action, String userId) throws LpRestException; 

    public void commentNotification(String modelSetId, String modelId, String artifactId, String resourceId, String action, String userId) throws LpRestException; 

    public void attachmentNotification(String modelSetId, String modelId, String artifactId, String resourceId, String action, String userId) throws LpRestException; 

    public void feedbackNotification(String modelSetId, String modelId, String artifactId, String resourceId, String action, String userId) throws LpRestException; 
}