org.bimserver.shared.interfaces.NotificationInterface Maven / Gradle / Ivy

package org.bimserver.shared.interfaces;

/******************************************************************************
 * Copyright (C) 2009-2017  BIMserver.org
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see {@literal}.
 *****************************************************************************/

import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebService;
import javax.jws.soap.SOAPBinding;
import javax.jws.soap.SOAPBinding.ParameterStyle;
import javax.jws.soap.SOAPBinding.Style;
import javax.jws.soap.SOAPBinding.Use;

import org.bimserver.interfaces.objects.SLongActionState;
import org.bimserver.shared.exceptions.ServerException;
import org.bimserver.shared.exceptions.UserException;

@WebService(name = "NotificationInterface", targetNamespace="org.bimserver")
@SOAPBinding(style = Style.DOCUMENT, use = Use.LITERAL, parameterStyle = ParameterStyle.WRAPPED)
public interface NotificationInterface extends PublicInterface {

	/**
	 * Called when there is a new revision
	 * 
	 * @param poid ProjectID
	 * @param roid RevisionID
	 * @throws UserException
	 * @throws ServerException
	 */
	@WebMethod(action = "newRevision")
	void newRevision(
		@WebParam(name = "poid", partName = "progress.poid") Long poid,
		@WebParam(name = "roid", partName = "progress.roid") Long roid) throws UserException, ServerException;

	/**
	 * Called when there is a new progress topic related to a project
	 * 
	 * @param poid ProjectID
	 * @param topicId The TopicID
	 * @throws UserException
	 * @throws ServerException
	 */
	@WebMethod(action = "newProgressOnProjectTopic")
	void newProgressOnProjectTopic(
		@WebParam(name = "poid", partName = "newProgressOnProjectTopic.poid") Long poid,
		@WebParam(name = "topicId", partName = "newProgressOnProjectTopic.topicId") Long topicId) throws UserException, ServerException;

	/**
	 * Called when the progress topic related to a project has been closed
	 * 
	 * @param poid ProjectID
	 * @param topicId TopicID
	 * @throws UserException
	 * @throws ServerException
	 */
	@WebMethod(action = "closedProgressOnProjectTopic")
	void closedProgressOnProjectTopic(
		@WebParam(name = "poid", partName = "closedProgressOnProjectTopic.poid") Long poid,
		@WebParam(name = "topicId", partName = "closedProgressOnProjectTopic.topicId") Long topicId) throws UserException, ServerException;

	/**
	 * Called when there is a new progress topic on a server
	 * 
	 * @param topicId
	 * @throws UserException
	 * @throws ServerException
	 */
	@WebMethod(action = "newProgressOnServerTopic")
	void newProgressOnServerTopic(
		@WebParam(name = "topicId", partName = "newProgressOnServerTopic.topicId") Long topicId) throws UserException, ServerException;
	
	/**
	 * Called when the progress topic on a server has been closed
	 * 
	 * @param topicId
	 * @throws UserException
	 * @throws ServerException
	 */
	@WebMethod(action = "closedProgressOnServerTopic")
	void closedProgressOnServerTopic(
		@WebParam(name = "topicId", partName = "closedProgressOnServerTopic.topicId") Long topicId) throws UserException, ServerException;
	
	/**
	 * Called then there is a new progress topic related to a revision
	 * 
	 * @param poid ProjectID
	 * @param roid RevisionID
	 * @param topicId TopicID
	 * @throws UserException
	 * @throws ServerException
	 */
	@WebMethod(action = "newProgressOnRevisionTopic")
	void newProgressOnRevisionTopic(
		@WebParam(name = "poid", partName = "newProgressOnRevisionTopic.poid") Long poid,
		@WebParam(name = "roid", partName = "newProgressOnRevisionTopic.roid") Long roid,
		@WebParam(name = "topicId", partName = "newProgressOnRevisionTopic.topicId") Long topicId) throws UserException, ServerException;

	/**
	 * Called when the progress topic related to a revision is closed
	 * 
	 * @param poid ProjectID
	 * @param roid RevisionID
	 * @param topicId TopicID
	 * @throws UserException
	 * @throws ServerException
	 */
	@WebMethod(action = "closedProgressOnRevisionTopic")
	void closedProgressOnRevisionTopic(
		@WebParam(name = "poid", partName = "closedProgressOnRevisionTopic.poid") Long poid,
		@WebParam(name = "roid", partName = "closedProgressOnRevisionTopic.roid") Long roid,
		@WebParam(name = "topicId", partName = "closedProgressOnRevisionTopic.topicId") Long topicId) throws UserException, ServerException;
	
	/**
	 * Called when there is a new progress topic
	 * 
	 * @param topicId TopicID
	 * @throws UserException
	 * @throws ServerException
	 */
	@WebMethod(action = "newProgressTopic")
	void newProgressTopic(
		@WebParam(name = "topicId", partName = "newProgressTopic.topicId") Long topicId) throws UserException, ServerException;
	
	/**
	 * Called when there is new extended data added to a revision
	 * 
	 * @param roid RevisionID
	 * @param edid ExtendedDataID
	 * @throws UserException
	 * @throws ServerException
	 */
	@WebMethod(action = "newExtendedData")
	void newExtendedData(
		@WebParam(name = "roid", partName = "newExtendedData.roid") Long roid,
		@WebParam(name = "edid", partName = "newExtendedData.edid") Long edid) throws UserException, ServerException;
	
	/**
	 * Called when a new project has been added
	 * 
	 * @param poid ProjectID
	 * @throws UserException
	 * @throws ServerException
	 */
	@WebMethod(action = "newProject")
	void newProject(
		@WebParam(name = "poid", partName = "newProject.poid") Long poid) throws UserException, ServerException;

	/**
	 * Called when a new user has been added
	 * 
	 * @param uoid UserID
	 * @throws UserException
	 * @throws ServerException
	 */
	@WebMethod(action = "newUser")
	void newUser(
		@WebParam(name = "uoid", partName = "newUser.uoid") Long uoid) throws UserException, ServerException;
	
	/**
	 * Called when new progress is available on a topic
	 * 
	 * @param topicId TopicID
	 * @param state Details of the progress update
	 * @throws UserException
	 * @throws ServerException
	 */
	@WebMethod(action = "progress")
	void progress(
		@WebParam(name = "topicId", partName = "progress.topicId") Long topicId, 
		@WebParam(name = "state", partName = "progress.state") SLongActionState state) throws UserException, ServerException;
}