|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.gcube.applicationsupportlayer.social.SocialPortalBridge
org.gcube.applicationsupportlayer.social.ApplicationNotificationsManager
public class ApplicationNotificationsManager
| Field Summary |
|---|
| Fields inherited from class org.gcube.applicationsupportlayer.social.SocialPortalBridge |
|---|
applicationProfile, aslSession |
| Constructor Summary | |
|---|---|
ApplicationNotificationsManager(org.gcube.application.framework.core.session.ASLSession session)
Use this constructor if you do not need notifications to point back to your applications |
|
ApplicationNotificationsManager(org.gcube.application.framework.core.session.ASLSession session,
String portletClassName)
Use this constructor if you do need notifications to point back to your applications, make sure you create your application profile on the infrastructure. |
|
| Method Summary | |
|---|---|
boolean |
notifyAddedItem(String userIdToNotify,
org.gcube.portlets.user.homelibrary.home.workspace.WorkspaceItem item,
org.gcube.portlets.user.homelibrary.home.workspace.WorkspaceFolder sharedFolder)
use to notify a user he got a workspace item new in some of his workspace shared folder |
boolean |
notifyCommentReply(String userIdToNotify,
String feedid,
String feedText)
use to notify a user that commented on a post (Not his) that someone commented too |
boolean |
notifyDocumentWorkflowFirstStepRequest(String userIdToNotify,
String documentWorkflowId,
String documentName,
String assignedRole)
use to notify a document workflow user that a new Document Workflow was created and he is involved in the first step and he is requested to do a task |
boolean |
notifyDocumentWorkflowStepForwardComplete(String userIdToNotify,
String documentWorkflowId,
String documentName,
String fromStepName,
String toStepName)
use to notify a document workflow owner that someone forwarded and the workflow moved to another step a document worflow he created |
boolean |
notifyDocumentWorkflowTaskRequest(String userIdToNotify,
String documentWorkflowId,
String documentName,
String assignedRoleName)
use to notify a document workflow user (user that in the same document workflow) that he is requested to do a task |
boolean |
notifyDocumentWorkflowUpdate(String userIdToNotify,
String documentWorkflowId,
String documentName)
use to notify a document workflow owner that someone has updated a document involved in a worflow he created |
boolean |
notifyDocumentWorkflowUserForward(String userIdToNotify,
String documentWorkflowId,
String documentName,
String fromStepName,
String toStepName)
use to notify a document workflow owner that a user performed a forward action to another step a document worflow he created |
boolean |
notifyDocumentWorkflowView(String userIdToNotify,
String documentWorkflowId,
String documentName)
use to notify a document workflow owner that someone has viewed a document involved in a worflow he created |
boolean |
notifyFolderAddedUser(String userIdToNotify,
org.gcube.portlets.user.homelibrary.home.workspace.WorkspaceFolder sharedFolder,
String newAddedUserId)
/** use to notify a user that a new user was added in on of his workspace shared folder |
boolean |
notifyFolderRemovedUser(String userIdToNotify,
org.gcube.portlets.user.homelibrary.home.workspace.WorkspaceFolder sharedFolder)
use to notify a user that an existing user was removed from one of his workspace shared folder |
boolean |
notifyFolderRenaming(String userIdToNotify,
String previousName,
String newName,
String renamedFolderId)
use to notify a user he got a workspace folder renamed |
boolean |
notifyFolderSharing(String userIdToNotify,
org.gcube.portlets.user.homelibrary.home.workspace.WorkspaceFolder sharedFolder)
use to notify a user he got a workspace folder shared |
boolean |
notifyJobStatus(String userIdToNotify,
org.gcube.portal.databook.shared.ApplicationProfile executingJobApId,
org.gcube.portal.databook.shared.RunningJob job)
use to notify a user he got one of his job finished |
boolean |
notifyLikedFeed(String userIdToNotify,
String feedid,
String feedText)
use to notify a user he got one of his post liked |
boolean |
notifyMessageReceived(String userIdToNotify,
String subject)
|
boolean |
notifyOwnCommentReply(String userIdToNotify,
String feedid,
String feedText)
use to notify a user that someone commented on his post |
boolean |
notifyRemovedItem(String userIdToNotify,
org.gcube.portlets.user.homelibrary.home.workspace.WorkspaceItem item,
org.gcube.portlets.user.homelibrary.home.workspace.WorkspaceFolder sharedFolder)
use to notify a user he got a workspace item deleted from one of his workspace shared folder |
boolean |
notifyUpdatedItem(String userIdToNotify,
org.gcube.portlets.user.homelibrary.home.workspace.WorkspaceItem item,
org.gcube.portlets.user.homelibrary.home.workspace.WorkspaceFolder sharedFolder)
use to notify a user he got a workspace item updated from one of his workspace shared folder |
| Methods inherited from class org.gcube.applicationsupportlayer.social.SocialPortalBridge |
|---|
escapeHtml, getApplicationProfile, getScopeByOrganizationId, getStoreInstance |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ApplicationNotificationsManager(org.gcube.application.framework.core.session.ASLSession session)
aslSession - the ASLSession instance
public ApplicationNotificationsManager(org.gcube.application.framework.core.session.ASLSession session,
String portletClassName)
aslSession - the ASLSession instanceportletClassName - your portlet class name will be used ad unique identifier for your applicationProfilehttp://gcube.wiki.gcube-system.org/gcube/index.php/Social_Networking_Library#Create_Your_Application_Profile| Method Detail |
|---|
public boolean notifyFolderSharing(String userIdToNotify,
org.gcube.portlets.user.homelibrary.home.workspace.WorkspaceFolder sharedFolder)
throws org.gcube.portlets.user.homelibrary.home.exceptions.InternalErrorException
notifyFolderSharing in interface NotificationsManageruserIdToNotify - the user you want to notifysharedFolder - the shared WorkspaceFolder
org.gcube.portlets.user.homelibrary.home.exceptions.InternalErrorException
public boolean notifyFolderRenaming(String userIdToNotify,
String previousName,
String newName,
String renamedFolderId)
throws org.gcube.portlets.user.homelibrary.home.exceptions.InternalErrorException
notifyFolderRenaming in interface NotificationsManageruserIdToNotify - the user you want to notifypreviousName - the previous name of the foldernewName - the new name of the folderrenamedFolderId - the folderId
org.gcube.portlets.user.homelibrary.home.exceptions.InternalErrorException
public boolean notifyFolderAddedUser(String userIdToNotify,
org.gcube.portlets.user.homelibrary.home.workspace.WorkspaceFolder sharedFolder,
String newAddedUserId)
throws org.gcube.portlets.user.homelibrary.home.exceptions.InternalErrorException,
org.gcube.vomanagement.usermanagement.exception.UserManagementSystemException,
org.gcube.vomanagement.usermanagement.exception.UserRetrievalFault,
org.gcube.vomanagement.usermanagement.exception.UserManagementPortalException
notifyFolderAddedUser in interface NotificationsManageruserIdToNotify - the user you want to notifysharedFolder - the shared WorkspaceFoldernewAddedUserId - the new user that was added
org.gcube.vomanagement.usermanagement.exception.UserManagementPortalException
org.gcube.vomanagement.usermanagement.exception.UserRetrievalFault
org.gcube.vomanagement.usermanagement.exception.UserManagementSystemException
org.gcube.portlets.user.homelibrary.home.exceptions.InternalErrorException
public boolean notifyFolderRemovedUser(String userIdToNotify,
org.gcube.portlets.user.homelibrary.home.workspace.WorkspaceFolder sharedFolder)
throws org.gcube.portlets.user.homelibrary.home.exceptions.InternalErrorException,
org.gcube.vomanagement.usermanagement.exception.UserManagementSystemException,
org.gcube.vomanagement.usermanagement.exception.UserRetrievalFault,
org.gcube.vomanagement.usermanagement.exception.UserManagementPortalException
notifyFolderRemovedUser in interface NotificationsManageruserIdToNotify - the user you want to notifysharedFolder - the shared WorkspaceFolder
org.gcube.portlets.user.homelibrary.home.exceptions.InternalErrorException
org.gcube.vomanagement.usermanagement.exception.UserManagementSystemException
org.gcube.vomanagement.usermanagement.exception.UserRetrievalFault
org.gcube.vomanagement.usermanagement.exception.UserManagementPortalException
public boolean notifyAddedItem(String userIdToNotify,
org.gcube.portlets.user.homelibrary.home.workspace.WorkspaceItem item,
org.gcube.portlets.user.homelibrary.home.workspace.WorkspaceFolder sharedFolder)
throws org.gcube.portlets.user.homelibrary.home.exceptions.InternalErrorException
notifyAddedItem in interface NotificationsManageruserIdToNotify - the user you want to notifysharedFolder - the shared folder WorkspaceFolder
org.gcube.portlets.user.homelibrary.home.exceptions.InternalErrorException
public boolean notifyRemovedItem(String userIdToNotify,
org.gcube.portlets.user.homelibrary.home.workspace.WorkspaceItem item,
org.gcube.portlets.user.homelibrary.home.workspace.WorkspaceFolder sharedFolder)
throws org.gcube.portlets.user.homelibrary.home.exceptions.InternalErrorException
notifyRemovedItem in interface NotificationsManageruserIdToNotify - the user you want to notifysharedFolder - the shared folder WorkspaceFolder
org.gcube.portlets.user.homelibrary.home.exceptions.InternalErrorException
public boolean notifyUpdatedItem(String userIdToNotify,
org.gcube.portlets.user.homelibrary.home.workspace.WorkspaceItem item,
org.gcube.portlets.user.homelibrary.home.workspace.WorkspaceFolder sharedFolder)
throws org.gcube.portlets.user.homelibrary.home.exceptions.InternalErrorException
notifyUpdatedItem in interface NotificationsManageruserIdToNotify - the user you want to notifysharedFolder - the shared folder WorkspaceFolder
org.gcube.portlets.user.homelibrary.home.exceptions.InternalErrorException
public boolean notifyMessageReceived(String userIdToNotify,
String subject)
notifyMessageReceived in interface NotificationsManageruserIdToNotify - the user you want to notifysubject - the subject of the message sent
public boolean notifyOwnCommentReply(String userIdToNotify,
String feedid,
String feedText)
notifyOwnCommentReply in interface NotificationsManageruserIdToNotify - the user you want to notifyfeedid - the liked feedidfeedText - the liked feed text or a portion of it
public boolean notifyCommentReply(String userIdToNotify,
String feedid,
String feedText)
notifyCommentReply in interface NotificationsManageruserIdToNotify - the user you want to notifyfeedid - the liked feedidfeedText - the liked feed text or a portion of it
public boolean notifyLikedFeed(String userIdToNotify,
String feedid,
String feedText)
notifyLikedFeed in interface NotificationsManageruserIdToNotify - the user you want to notifyfeedid - the liked feedidfeedText - the liked feed text or a portion of it
public boolean notifyJobStatus(String userIdToNotify,
org.gcube.portal.databook.shared.ApplicationProfile executingJobApId,
org.gcube.portal.databook.shared.RunningJob job)
notifyJobStatus in interface NotificationsManageruserIdToNotify - the user you want to notify
public boolean notifyDocumentWorkflowView(String userIdToNotify,
String documentWorkflowId,
String documentName)
notifyDocumentWorkflowView in interface NotificationsManageruserIdToNotify - the user you want to notifydocumentName - the document title
public boolean notifyDocumentWorkflowUpdate(String userIdToNotify,
String documentWorkflowId,
String documentName)
notifyDocumentWorkflowUpdate in interface NotificationsManageruserIdToNotify - the user you want to notifydocumentName - the document title
public boolean notifyDocumentWorkflowTaskRequest(String userIdToNotify,
String documentWorkflowId,
String documentName,
String assignedRoleName)
notifyDocumentWorkflowTaskRequest in interface NotificationsManageruserIdToNotify - the user you want to notifydocumentName - the document title
public boolean notifyDocumentWorkflowUserForward(String userIdToNotify,
String documentWorkflowId,
String documentName,
String fromStepName,
String toStepName)
notifyDocumentWorkflowUserForward in interface NotificationsManageruserIdToNotify - the owner of this document workflowfromStepName - the name of the step from which the user performed the forwardtoStepName - the name of the step to which the user performed the forward
public boolean notifyDocumentWorkflowStepForwardComplete(String userIdToNotify,
String documentWorkflowId,
String documentName,
String fromStepName,
String toStepName)
notifyDocumentWorkflowStepForwardComplete in interface NotificationsManageruserIdToNotify - the owner of this document workflowfromStepName - the name of the step from which the user performed the forwardtoStepName - the name of the step to which the user performed the forward
public boolean notifyDocumentWorkflowFirstStepRequest(String userIdToNotify,
String documentWorkflowId,
String documentName,
String assignedRole)
notifyDocumentWorkflowFirstStepRequest in interface NotificationsManageruserIdToNotify - the user you want to notifydocumentName - the document title
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||