aslsocial/src/main/java/org/gcube/applicationsupportlayer/social/NotificationManager.java

61 lines
2.6 KiB
Java
Raw Normal View History

package org.gcube.applicationsupportlayer.social;
import org.gcube.portlets.user.homelibrary.home.workspace.WorkspaceFolder;
import org.gcube.portlets.user.homelibrary.home.workspace.WorkspaceItem;
/**
*
* @author Massimiliano Assante, ISTI-CNR
* @version 0.1 Dec 2012
*
*/
public interface NotificationManager {
/**
* use to notify a user he got a workspace folder shared
*
* @param userIdToNotify the user you want to notify
* @param sharedFolder the shared {@link WorkspaceFolder}
* @return true id the notification is correctly delivered, false otherwise
*/
boolean notifyFolderSharing(String userIdToNotify, WorkspaceFolder sharedFolder);
/**
* use to notify a user that a new user was added in on of his workspace shared folder
*
* @param userIdToNotify the user you want to notify
* @param sharedFolder the shared {@link WorkspaceFolder}
* @param newAddedUserId the new user that was added
* @return true id the notification is correctly delivered, false otherwise
*/
boolean notifyFolderAddedUser(String userIdToNotify, WorkspaceFolder sharedFolder, String newAddedUserId);
/**
* use to notify a user that an existing user was removed from one of his workspace shared folder
*
* @param userIdToNotify the user you want to notify
* @param sharedFolder the shared {@link WorkspaceFolder}
* @param removedUserId the new user that was removed
* @return true id the notification is correctly delivered, false otherwise
*/
boolean notifyFolderRemovedUser(String userIdToNotify, WorkspaceFolder sharedFolder, String removedUserId);
/**
* use to notify a user he got a workspace item new in some of his workspace shared folder
* @param userIdToNotify
* @param newItem the new shared {@link WorkspaceItem}
* @return true id the notification is correctly delivered, false otherwise
*/
boolean notifyAddedItem(String userIdToNotify, WorkspaceItem newItem);
/**
* use to notify a user he got a workspace item deleted from one of his workspace shared folder
* @param userIdToNotify
* @param removedItem the removed {@link WorkspaceItem}
* @return true id the notification is correctly delivered, false otherwise
*/
boolean notifyRemovedItem(String userIdToNotify, WorkspaceItem removedItem);
/**
* use to notify a user he got a workspace item updated from one of his workspace shared folder
* @param userIdToNotify
* @param newItem the new shared {@link WorkspaceItem}
* @return true id the notification is correctly delivered, false otherwise
*/
boolean notifyUpdatedItem(String userIdToNotify, WorkspaceItem updatedItem);
}