Package org.gcube.portal.databook.server

Interface DatabookStore

All Known Implementing Classes:

DBCassandraAstyanaxImpl

public interface DatabookStore

High-level interface for querying and managing social data in the DatabookStore.

Provides methods for managing friendships, posts, feeds, comments, likes, notifications, and user/app timelines. Most methods return true if the operation was successful.

Note: Many methods are deprecated in favor of the new Post-based API.

Author:

Massimiliano Assante ISTI-CNR, Costantino Perciante ISTI-CNR

Method Summary

Modifier and Type	Method	Description
boolean	addComment(Comment comment)	add a comment to a feed
boolean	approveFriendship(String from, String to)	Approves a friendship request from one user to another.
boolean	checkUnreadMessagesNotifications(String userid)
boolean	checkUnreadNotifications(String userid)
void	closeConnection()	close the connection to the underlying database
boolean	deleteComment(String commentid, String feedid)	deletes a comment
boolean	deleteFeed(String feedid)	Deprecated. use saveUserPost
boolean	deleteHashTags(String postid, String vreid, List<String> hashtags)
boolean	deleteHashTagsComment(String commentId, String vreid, List<String> hashtags)
boolean	deletePost(String postid)	delete a Feed from the store
boolean	denyFriendship(String from, String to)	Denies a friendship request from one user to another.
boolean	editComment(Comment comment)	edit a comment
List<Comment>	getAllCommentByFeed(String feedid)	Deprecated. use getAllCommentByPost
List<Comment>	getAllCommentByPost(String postid)
List<Feed>	getAllFeedsByApp(String appid)	Deprecated. use getAllPostsByApp instead
List<Feed>	getAllFeedsByUser(String userid)	Deprecated. use getAllPostsByUser instead
List<Feed>	getAllFeedsByVRE(String vreid)	Deprecated. use getAllPostsByVRE
List<String>	getAllLikedFeedIdsByUser(String userid)	Deprecated. use getAllLikedPostIdsByUser
List<Feed>	getAllLikedFeedsByUser(String userid, int limit)	Deprecated. use getAllLikedPostsByUser
List<String>	getAllLikedPostIdsByUser(String userid)
List<Post>	getAllLikedPostsByUser(String userid, int limit)
List<Like>	getAllLikesByFeed(String postid)	Deprecated. use getAllLikesByPost
List<Like>	getAllLikesByPost(String postid)
List<Notification>	getAllNotificationByUser(String userid, int limit)
List<Feed>	getAllPortalPrivacyLevelFeeds()	Deprecated. use getAllPortalPrivacyLevelPosts instead return all the feeds whose Level is PORTAL
List<Post>	getAllPortalPrivacyLevelPosts()	return all the feeds whose Level is PORTAL
List<Post>	getAllPostsByApp(String appid)
List<Post>	getAllPostsByUser(String userid)
List<Post>	getAllPostsByVRE(String vreid)	Returns all posts for a specified VRE.
List<String>	getAllVREIds()	Retrieve all the ids of the vre
List<Attachment>	getAttachmentsByFeedId(String feedId)
List<String>	getFriends(String userid)	Gets the list of friends for a specified user.
List<Invite>	getInvitedEmailsByVRE(String vreid, InviteStatus... status)	Use to get the list of invites per VRE
List<String>	getPendingFriendRequests(String userid)	Gets the list of pending friend requests for a specified user.
List<Notification>	getRangeNotificationsByUser(String userid, int from, int quantity)
List<Feed>	getRecentCommentedFeedsByUserAndDate(String userid, long timeInMillis)	Deprecated. use getRecentCommentedPostsByUserAndDate instead
List<Post>	getRecentCommentedPostsByUserAndDate(String userid, long timeInMillis)
List<Comment>	getRecentCommentsByUserAndDate(String userid, long timeInMillis)
List<Feed>	getRecentFeedsByUser(String userid, int quantity)	Deprecated.
List<Feed>	getRecentFeedsByUserAndDate(String userid, long timeInMillis)	Deprecated. use getRecentPostsByUserAndDate
List<Feed>	getRecentFeedsByVRE(String vreid, int quantity)	Deprecated. use getRecentPostsByVRE return the most recent feeds for this vre up to quantity param
RangeFeeds	getRecentFeedsByVREAndRange(String vreid, int from, int quantity)	Deprecated. Use getRecentPostsByVREAndRange(String, int, int) instead.
List<Feed>	getRecentLikedFeedsByUserAndDate(String userid, long timeInMillis)	Deprecated. use getRecentLikedPostsByUserAndDate
List<Post>	getRecentLikedPostsByUserAndDate(String userid, long timeInMillis)
List<Post>	getRecentPostsByUser(String userid, int quantity)	return the most recent feeds for this user up to quantity param
List<Post>	getRecentPostsByUserAndDate(String userid, long timeInMillis)
List<Post>	getRecentPostsByVRE(String vreid, int quantity)	Returns the most recent posts for a VRE, up to the specified quantity.
RangePosts	getRecentPostsByVREAndRange(String vreid, int from, int quantity)	Returns the most recent posts for a VRE within a specified range, and provides the last index of posts in the timeline for pagination purposes.
List<Notification>	getUnreadNotificationsByUser(String userid)	Returns all unread notifications for a user (excluding message notifications).
List<NotificationChannelType>	getUserNotificationChannels(String userid, NotificationType notificationType)	Returns the notification channels a user has chosen for a given notification type.
Map<NotificationType,NotificationChannelType[]>	getUserNotificationPreferences(String userid)	Gets the notification preferences map (enable or disable the channels to be used for notifying the user).
List<Feed>	getVREFeedsByHashtag(String vreid, String hashtag)	Deprecated. use getVREPostsByHashtag
Map<String,Integer>	getVREHashtagsWithOccurrence(String vreid)	get a map of VRE hashtags where the key is the hashtag and the value is the occurrence of the hashtag in the VRE.
Map<String,Integer>	getVREHashtagsWithOccurrenceFilteredByTime(String vreid, long timestamp)	get a map of VRE hashtags where the key is the hashtag and the value is the occurrence of the hashtag in the VRE.
List<Post>	getVREPostsByHashtag(String vreid, String hashtag)	Returns all posts in a VRE that contain a specific hashtag.
String	isExistingInvite(String vreid, String email)
boolean	like(Like like)	add a like to a feed
Comment	readCommentById(String commentId)
Feed	readFeed(String feedid)	Deprecated. use readPost read a feed from a given id
Invite	readInvite(String inviteid)	read an invite from a given id
Notification	readNotification(String notificationid)	Reads a notification from a given ID.
Post	readPost(String postid)	read a feed from a given id
boolean	requestFriendship(String from, String to)	Requests a friendship from one user to another.
boolean	saveAppFeed(Feed feed)	Deprecated. use saveAppPost save a Post instance in the store
boolean	saveAppFeed(Feed feed, List<Attachment> attachments)	Deprecated. use saveAppPost Save a Post instance in the store Use this if your app needs to attach more than one file to the post
boolean	saveAppPost(Post feed)	save a Post instance in the store
boolean	saveAppPost(Post feed, List<Attachment> attachments)	Save a Post instance in the store Use this if your app needs to attach more than one file to the post
boolean	saveAttachmentEntry(String feedId, Attachment toSave)	save an attachment
boolean	saveFeedToVRETimeline(String feedKey, String vreid)	Deprecated. use savePostToVRETimeline
boolean	saveHashTags(String postid, String vreid, List<String> hashtags)
boolean	saveHashTagsComment(String commentId, String vreid, List<String> hashtags)
InviteOperationResult	saveInvite(Invite invite)	Save the invite for a given email into a given vre
boolean	saveNotification(Notification notification)	save a Notification instance in the store
boolean	savePostToVRETimeline(String postKey, String vreid)	save a post in the VRES TimeLine in the store
boolean	saveUserFeed(Feed feed)	Deprecated. use saveUserPost save a Feed instance in the store
boolean	saveUserFeed(Feed feed, List<Attachment> attachments)	Deprecated. use saveUserPost
boolean	saveUserPost(Post feed)	save a Post instance in the store
boolean	saveUserPost(Post post, List<Attachment> attachments)	Save a Post instance in the store having more than one attachment Use this if you need to attach more than one file to the post
boolean	setAllNotificationReadByUser(String userid)	This is a fast way to set all notification to read quickly
boolean	setInviteStatus(String vreid, String email, InviteStatus status)	set the status of an invite, see InviteStatus
boolean	setNotificationRead(String notificationidToSet)	set an existing Notification instance in the to read
boolean	setUserNotificationPreferences(String userid, Map<NotificationType,NotificationChannelType[]> enabledChannels)	set the notification preferences map (enable or disable the channels to be used for notifying the user)
boolean	unlike(String userid, String likeid, String feedid)	unlike a feed

Method Details

requestFriendship

boolean requestFriendship(String from,
 String to)

Requests a friendship from one user to another.

Parameters:

from - The user ID requesting the friendship.

to - The user ID receiving the friendship request.

Returns:

true if the operation was successful.

approveFriendship

boolean approveFriendship(String from,
 String to)

Approves a friendship request from one user to another.

Parameters:

from - The user ID approving the friendship.

to - The user ID being approved.

Returns:

true if the operation was successful.

denyFriendship

boolean denyFriendship(String from,
 String to)

Denies a friendship request from one user to another.

Parameters:

from - The user ID denying the friendship.

to - The user ID being denied.

Returns:

true if the operation was successful.

getFriends

List<String> getFriends(String userid)

Gets the list of friends for a specified user.

Parameters:

userid - The user ID to get friends for.

Returns:

A List of user IDs representing the friends of the given user.

getPendingFriendRequests

List<String> getPendingFriendRequests(String userid)

Gets the list of pending friend requests for a specified user.

Parameters:

userid - The user ID to get pending friend requests for.

Returns:

A List of user IDs representing pending friend requests for the given user.

saveUserFeed

boolean saveUserFeed(Feed feed)

Deprecated.

use saveUserPost save a Feed instance in the store

Returns:

true if everything went fine

saveUserPost

boolean saveUserPost(Post feed)

save a Post instance in the store

Returns:

true if everything went fine

saveUserFeed

boolean saveUserFeed(Feed feed,
 List<Attachment> attachments)

Deprecated.

use saveUserPost

Save a Feed instance in the store having more than one attachment Use this if you need to attach more than one file to the post

Parameters:

attachments - a list of attachments starting from the second

Returns:

true if everything went fine

saveUserPost

boolean saveUserPost(Post post,
 List<Attachment> attachments)

Save a Post instance in the store having more than one attachment Use this if you need to attach more than one file to the post

Parameters:

attachments - a list of attachments starting from the second

Returns:

true if everything went fine

deleteFeed

boolean deleteFeed(String feedid)
            throws FeedIDNotFoundException,
PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException

Deprecated.

use saveUserPost

Delete a Feed from the store

Returns:

true if everything went fine

Throws:

FeedIDNotFoundException

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

deletePost

boolean deletePost(String postid)
            throws FeedIDNotFoundException,
PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException

delete a Feed from the store

Returns:

true if everything went fine

Throws:

FeedIDNotFoundException

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

saveFeedToVRETimeline

boolean saveFeedToVRETimeline(String feedKey,
 String vreid)
                       throws FeedIDNotFoundException

Deprecated.

use savePostToVRETimeline

Save a post in the VRES TimeLine in the store

Parameters:

feedKey - feedKey

vreid - vre identifier

Throws:

FeedIDNotFoundException

savePostToVRETimeline

boolean savePostToVRETimeline(String postKey,
 String vreid)
                       throws FeedIDNotFoundException

save a post in the VRES TimeLine in the store

Parameters:

postKey - the post id

vreid - vre identifier

Throws:

FeedIDNotFoundException

saveAppFeed

boolean saveAppFeed(Feed feed)

Deprecated.

use saveAppPost save a Post instance in the store

Returns:

true if everything went fine

saveAppPost

boolean saveAppPost(Post feed)

save a Post instance in the store

Returns:

true if everything went fine

saveAppFeed

boolean saveAppFeed(Feed feed,
 List<Attachment> attachments)

Deprecated.

use saveAppPost Save a Post instance in the store Use this if your app needs to attach more than one file to the post

Parameters:

attachments - a list of attachments starting from the second

Returns:

true if everything went fine

saveAppPost

boolean saveAppPost(Post feed,
 List<Attachment> attachments)

Save a Post instance in the store Use this if your app needs to attach more than one file to the post

Parameters:

attachments - a list of attachments starting from the second

Returns:

true if everything went fine

readFeed

Feed readFeed(String feedid)
       throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
FeedIDNotFoundException,
ColumnNameNotFoundException

Deprecated.

use readPost read a feed from a given id

Throws:

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

FeedIDNotFoundException

readPost

Post readPost(String postid)
       throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
FeedIDNotFoundException,
ColumnNameNotFoundException

read a feed from a given id

Throws:

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

FeedIDNotFoundException

getAllFeedsByUser

List<Feed> getAllFeedsByUser(String userid)
                      throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
FeedIDNotFoundException,
ColumnNameNotFoundException

Deprecated.

use getAllPostsByUser instead

Parameters:

userid - user identifier return all the feeds belonging to the userid

Throws:

FeedTypeNotFoundException

PrivacyLevelTypeNotFoundException

ColumnNameNotFoundException

FeedIDNotFoundException

getAllPostsByUser

List<Post> getAllPostsByUser(String userid)
                      throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
FeedIDNotFoundException,
ColumnNameNotFoundException

Parameters:

userid - user identifier return all the feeds belonging to the userid

Throws:

FeedTypeNotFoundException

PrivacyLevelTypeNotFoundException

ColumnNameNotFoundException

FeedIDNotFoundException

getAllFeedsByApp

List<Feed> getAllFeedsByApp(String appid)
                     throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
FeedIDNotFoundException,
ColumnNameNotFoundException

Deprecated.

use getAllPostsByApp instead

Parameters:

appid - application identifier return all the feeds belonging to the appid

Throws:

FeedTypeNotFoundException

PrivacyLevelTypeNotFoundException

ColumnNameNotFoundException

FeedIDNotFoundException

getAllPostsByApp

List<Post> getAllPostsByApp(String appid)
                     throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
FeedIDNotFoundException,
ColumnNameNotFoundException

Parameters:

appid - application identifier return all the feeds belonging to the appid

Throws:

FeedTypeNotFoundException

PrivacyLevelTypeNotFoundException

ColumnNameNotFoundException

FeedIDNotFoundException

getRecentCommentedFeedsByUserAndDate

List<Feed> getRecentCommentedFeedsByUserAndDate(String userid,
 long timeInMillis)
                                         throws Exception

Deprecated.

use getRecentCommentedPostsByUserAndDate instead

Parameters:

userid - the user identifier like andrea.rossi

timeInMillis - the initial time in millis to be considered

Returns:

a list of feeds commented by userid starting from timeInMillis

Throws:

Exception

getRecentCommentedPostsByUserAndDate

List<Post> getRecentCommentedPostsByUserAndDate(String userid,
 long timeInMillis)
                                         throws Exception

Parameters:

userid - the user identifier like andrea.rossi

timeInMillis - the initial time in millis to be considered

Returns:

a list of feeds commented by userid starting from timeInMillis

Throws:

Exception

getAllPortalPrivacyLevelFeeds

List<Feed> getAllPortalPrivacyLevelFeeds()
                                  throws FeedTypeNotFoundException,
ColumnNameNotFoundException,
PrivacyLevelTypeNotFoundException

Deprecated.

use getAllPortalPrivacyLevelPosts instead return all the feeds whose Level is PORTAL

Throws:

PrivacyLevelTypeNotFoundException

ColumnNameNotFoundException

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

getAllPortalPrivacyLevelPosts

List<Post> getAllPortalPrivacyLevelPosts()
                                  throws FeedTypeNotFoundException,
ColumnNameNotFoundException,
PrivacyLevelTypeNotFoundException

return all the feeds whose Level is PORTAL

Throws:

PrivacyLevelTypeNotFoundException

ColumnNameNotFoundException

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

getRecentFeedsByUser

List<Feed> getRecentFeedsByUser(String userid,
 int quantity)
                         throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

Deprecated.

return the most recent feeds for this user up to quantity param

Parameters:

userid - user identifier

quantity - the number of most recent feeds for this user

Returns:

a List of most recent feeds for this user

Throws:

FeedTypeNotFoundException

PrivacyLevelTypeNotFoundException

ColumnNameNotFoundException

FeedIDNotFoundException

getRecentPostsByUser

List<Post> getRecentPostsByUser(String userid,
 int quantity)
                         throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

return the most recent feeds for this user up to quantity param

Parameters:

userid - user identifier

quantity - the number of most recent feeds for this user

Returns:

a List of most recent feeds for this user

Throws:

FeedTypeNotFoundException

PrivacyLevelTypeNotFoundException

ColumnNameNotFoundException

FeedIDNotFoundException

getAllFeedsByVRE

List<Feed> getAllFeedsByVRE(String vreid)
                     throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

Deprecated.

use getAllPostsByVRE

Parameters:

vreid - vre identifier return all the feeds belonging to the userid

Throws:

FeedTypeNotFoundException

PrivacyLevelTypeNotFoundException

ColumnNameNotFoundException

FeedIDNotFoundException

getAllPostsByVRE

List<Post> getAllPostsByVRE(String vreid)
                     throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

Returns all posts for a specified VRE.

Parameters:

vreid - The VRE identifier.

Returns:

A List of all posts belonging to the specified VRE.

Throws:

FeedTypeNotFoundException - If a feed type is not recognized.

PrivacyLevelTypeNotFoundException - If a privacy level is not recognized.

ColumnNameNotFoundException - If a column name is not found.

FeedIDNotFoundException - If a feed ID is not found.

getRecentFeedsByVRE

List<Feed> getRecentFeedsByVRE(String vreid,
 int quantity)
                        throws IllegalArgumentException,
PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

Deprecated.

use getRecentPostsByVRE return the most recent feeds for this vre up to quantity param

Parameters:

vreid - VRES identifier

quantity - the number of most recent feeds for this vre

Returns:

a List of most recent feeds for this vre

Throws:

FeedTypeNotFoundException

PrivacyLevelTypeNotFoundException

ColumnNameNotFoundException

IllegalArgumentException

FeedIDNotFoundException

getRecentPostsByVRE

List<Post> getRecentPostsByVRE(String vreid,
 int quantity)
                        throws IllegalArgumentException,
PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

Returns the most recent posts for a VRE, up to the specified quantity.

Parameters:

vreid - The VRE identifier.

quantity - The maximum number of most recent posts to return.

Returns:

A List of most recent posts for this VRE.

Throws:

IllegalArgumentException - If vreid is null or quantity is invalid.

FeedTypeNotFoundException - If a feed type is not recognized.

PrivacyLevelTypeNotFoundException - If a privacy level is not recognized.

ColumnNameNotFoundException - If a column name is not found.

FeedIDNotFoundException - If a feed ID is not found.

getRecentFeedsByVREAndRange

RangeFeeds getRecentFeedsByVREAndRange(String vreid,
 int from,
 int quantity)
                                throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

Deprecated.

Use getRecentPostsByVREAndRange(String, int, int) instead.

Returns the most recent posts for this VRE up to the specified quantity and the last index of the posts in the timeline. The lastReturnedFeedTimelineIndex is useful to know from where to start the range the next time you query, as there may be deletions.

Parameters:

vreid - The VRE identifier.

from - The range start (most recent posts for this VRE). Must be greater than 0.

quantity - The number of most recent posts for this VRE starting from the "from" parameter.

Returns:

A RangeFeeds containing the most recent posts for this VRE and the last index in the timeline.

Throws:

FeedTypeNotFoundException - If a feed type is not recognized.

PrivacyLevelTypeNotFoundException - If a privacy level is not recognized.

ColumnNameNotFoundException - If a column name is not found.

FeedIDNotFoundException - If a feed ID is not found.

getRecentPostsByVREAndRange

RangePosts getRecentPostsByVREAndRange(String vreid,
 int from,
 int quantity)
                                throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

Returns the most recent posts for a VRE within a specified range, and provides the last index of posts in the timeline for pagination purposes.

Parameters:

vreid - The VRE identifier.

from - The starting index (0-based) for retrieving posts. Must be greater than 0.

quantity - The maximum number of posts to retrieve starting from the "from" index.

Returns:

A RangePosts containing the most recent posts for this VRE and pagination metadata.

Throws:

FeedTypeNotFoundException - If a feed type is not recognized.

PrivacyLevelTypeNotFoundException - If a privacy level is not recognized.

ColumnNameNotFoundException - If a column name is not found.

FeedIDNotFoundException - If a feed ID is not found.

getRecentFeedsByUserAndDate

List<Feed> getRecentFeedsByUserAndDate(String userid,
 long timeInMillis)
                                throws IllegalArgumentException

Deprecated.

use getRecentPostsByUserAndDate

Parameters:

userid - user identifier

timeInMillis - time in milliseconds from which you want to start retrieve the feeds

Returns:

the number of feeds in the range from: today to: timeInMillis

Throws:

IllegalArgumentException

getRecentPostsByUserAndDate

List<Post> getRecentPostsByUserAndDate(String userid,
 long timeInMillis)
                                throws IllegalArgumentException

Parameters:

userid - user identifier

timeInMillis - time in milliseconds from which you want to start retrieve the feeds

Returns:

the number of feeds in the range from: today to: timeInMillis

Throws:

IllegalArgumentException

saveNotification

boolean saveNotification(Notification notification)

save a Notification instance in the store

Returns:

true if everything went fine

setNotificationRead

boolean setNotificationRead(String notificationidToSet)
                     throws NotificationIDNotFoundException,
NotificationTypeNotFoundException,
ColumnNameNotFoundException

set an existing Notification instance in the to read

Returns:

true if everything went fine

Throws:

NotificationIDNotFoundException

NotificationTypeNotFoundException

ColumnNameNotFoundException

readNotification

Notification readNotification(String notificationid)
                       throws NotificationIDNotFoundException,
NotificationTypeNotFoundException,
ColumnNameNotFoundException

Reads a notification from a given ID.

Parameters:

notificationid - The notification ID to read.

Returns:

The Notification corresponding to the given ID.

Throws:

ColumnNameNotFoundException - If a column name is not found.

NotificationIDNotFoundException - If a notification ID is not found.

NotificationTypeNotFoundException - If a notification type is not recognized.

getAllNotificationByUser

List<Notification> getAllNotificationByUser(String userid,
 int limit)
                                     throws NotificationTypeNotFoundException,
ColumnNameNotFoundException,
NotificationIDNotFoundException

Parameters:

userid - user identifier

limit - set 0 to get everything, an int to get the most recent -limit- notifications return all the notifications belonging to the userid up to limit, set 0 to get everything

Throws:

NotificationTypeNotFoundException

ColumnNameNotFoundException

NotificationIDNotFoundException

getRangeNotificationsByUser

List<Notification> getRangeNotificationsByUser(String userid,
 int from,
 int quantity)
                                        throws NotificationTypeNotFoundException,
ColumnNameNotFoundException,
NotificationIDNotFoundException

Parameters:

userid - user identifier

from - the range start has to be greater than 0

quantity - the number of most recent notifications for this user starting from "from" param

Returns:

all the notifications for the userid in the range requested

Throws:

NotificationTypeNotFoundException

ColumnNameNotFoundException

NotificationIDNotFoundException

setAllNotificationReadByUser

boolean setAllNotificationReadByUser(String userid)
                              throws NotificationIDNotFoundException,
NotificationTypeNotFoundException,
ColumnNameNotFoundException

This is a fast way to set all notification to read quickly

Parameters:

userid -

Returns:

true if everything went fine

Throws:

ColumnNameNotFoundException - If a column name is not found.

NotificationIDNotFoundException - If a notification ID is not found.

NotificationTypeNotFoundException - If a notification type is not recognized.

getUnreadNotificationsByUser

List<Notification> getUnreadNotificationsByUser(String userid)
                                         throws NotificationTypeNotFoundException,
ColumnNameNotFoundException,
NotificationIDNotFoundException

Returns all unread notifications for a user (excluding message notifications).

Parameters:

userid - The user identifier.

Returns:

A List of unread notifications for this user.

Throws:

NotificationTypeNotFoundException - If a notification type is not recognized.

ColumnNameNotFoundException - If a column name is not found.

NotificationIDNotFoundException - If a notification ID is not found.

checkUnreadNotifications

boolean checkUnreadNotifications(String userid)
                          throws NotificationIDNotFoundException,
NotificationTypeNotFoundException,
ColumnNameNotFoundException

Parameters:

userid - user identifier

Returns:

true if there are unread notifications (not including messages), false if they are all read

Throws:

ColumnNameNotFoundException

NotificationTypeNotFoundException

NotificationIDNotFoundException

checkUnreadMessagesNotifications

boolean checkUnreadMessagesNotifications(String userid)
                                  throws NotificationIDNotFoundException,
NotificationTypeNotFoundException,
ColumnNameNotFoundException

Parameters:

userid - user identifier

Returns:

true if there are unread messages notifications (including messages), false if they are all read

Throws:

ColumnNameNotFoundException - If a column name is not found.

NotificationTypeNotFoundException - If a notification type is not recognized.

NotificationIDNotFoundException - If a notification ID is not found.

getUserNotificationChannels

List<NotificationChannelType> getUserNotificationChannels(String userid,
 NotificationType notificationType)
                                                   throws NotificationChannelTypeNotFoundException,
NotificationTypeNotFoundException

Returns the notification channels a user has chosen for a given notification type.

Parameters:

userid - The user identifier.

notificationType - The type of notification.

Returns:

A list of NotificationChannelType representing the channels this user wants to be notified on.

Throws:

NotificationChannelTypeNotFoundException - If a notification channel type is not recognized.

NotificationTypeNotFoundException - If a notification type is not recognized.

setUserNotificationPreferences

boolean setUserNotificationPreferences(String userid,
 Map<NotificationType,NotificationChannelType[]> enabledChannels)

set the notification preferences map (enable or disable the channels to be used for notifying the user)

Parameters:

userid - user identifier

enabledChannels - a map of the channels to which reach the user per notification, empty array or null values to set the key notification type off

Returns:

true if everything was fine

getUserNotificationPreferences

Map<NotificationType,NotificationChannelType[]> getUserNotificationPreferences(String userid)
                                                                        throws NotificationTypeNotFoundException,
NotificationChannelTypeNotFoundException

Gets the notification preferences map (enable or disable the channels to be used for notifying the user).

Parameters:

userid - The user identifier.

Returns:

The map of NotificationType to NotificationChannelType.

Throws:

NotificationTypeNotFoundException - If a notification type is not recognized.

NotificationChannelTypeNotFoundException - If a notification channel type is not recognized.

readCommentById

Comment readCommentById(String commentId)
                 throws CommentIDNotFoundException

Parameters:

commentId - comment unique identifier

Returns:

the comment belonging to the commentId

Throws:

CommentIDNotFoundException

addComment

boolean addComment(Comment comment)
            throws FeedIDNotFoundException

add a comment to a feed

Parameters:

comment - the Comment instance to add

Throws:

FeedIDNotFoundException

getAllCommentByFeed

List<Comment> getAllCommentByFeed(String feedid)

Deprecated.

use getAllCommentByPost

Parameters:

feedid - feed identifier return all the comments belonging to the feedid

getAllCommentByPost

List<Comment> getAllCommentByPost(String postid)

Parameters:

postid - the post identifier return all the comments belonging to the postid

getRecentCommentsByUserAndDate

List<Comment> getRecentCommentsByUserAndDate(String userid,
 long timeInMillis)
                                      throws Exception

Parameters:

userid - user identifier

timeInMillis - time in milliseconds from which you want to start retrieve the feeds

Returns:

a list of comments (sorted starting from the most recent one) made by the user since timeInMillis up to now

Throws:

Exception

editComment

boolean editComment(Comment comment)
             throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
CommentIDNotFoundException,
FeedIDNotFoundException

edit a comment

Parameters:

comment - the comment to edit

Returns:

true if success, false otherwise

Throws:

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

CommentIDNotFoundException

FeedIDNotFoundException

deleteComment

boolean deleteComment(String commentid,
 String feedid)
               throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
CommentIDNotFoundException,
FeedIDNotFoundException

deletes a comment

Parameters:

commentid - the comment identifier to delete

feedid - the feedid to which the comment is associated

Returns:

true if success, false otherwise

Throws:

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

CommentIDNotFoundException

FeedIDNotFoundException

like

boolean like(Like like)
      throws FeedIDNotFoundException

add a like to a feed

Parameters:

like - instance

Throws:

FeedIDNotFoundException

unlike

boolean unlike(String userid,
 String likeid,
 String feedid)
        throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
LikeIDNotFoundException,
FeedIDNotFoundException

unlike a feed

Parameters:

userid - user identifier

likeid - the like identifier to delete

feedid - the feedid to which the comment is associated

Returns:

true if success, false otherwise

Throws:

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

LikeIDNotFoundException

FeedIDNotFoundException

getAllLikedFeedIdsByUser

List<String> getAllLikedFeedIdsByUser(String userid)

Deprecated.

use getAllLikedPostIdsByUser

Parameters:

userid - user identifier return all the feedids a user has liked

getAllLikedPostIdsByUser

List<String> getAllLikedPostIdsByUser(String userid)

Parameters:

userid - user identifier return all the feedids a user has liked

getAllLikedFeedsByUser

List<Feed> getAllLikedFeedsByUser(String userid,
 int limit)
                           throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
FeedIDNotFoundException,
ColumnNameNotFoundException

Deprecated.

use getAllLikedPostsByUser

Parameters:

userid - user identifier

limit - set 0 to get everything, an int to get the most recent -limit- liked feeds

Throws:

ColumnNameNotFoundException - .

FeedIDNotFoundException - .

FeedTypeNotFoundException - .

PrivacyLevelTypeNotFoundException

FeedIDNotFoundException - . return all the feeds a user has liked

getAllLikedPostsByUser

List<Post> getAllLikedPostsByUser(String userid,
 int limit)
                           throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
FeedIDNotFoundException,
ColumnNameNotFoundException

Parameters:

userid - user identifier

limit - set 0 to get everything, an int to get the most recent -limit- liked posts

Throws:

ColumnNameNotFoundException - .

FeedIDNotFoundException - .

FeedTypeNotFoundException - .

PrivacyLevelTypeNotFoundException

FeedIDNotFoundException - . return all the feeds a user has liked

getRecentLikedFeedsByUserAndDate

List<Feed> getRecentLikedFeedsByUserAndDate(String userid,
 long timeInMillis)
                                     throws IllegalArgumentException

Deprecated.

use getRecentLikedPostsByUserAndDate

Parameters:

userid - user identifier

timeInMillis - time in milliseconds from which you want to start retrieve the feeds

Returns:

the likes made to feeds in the range from: today to: timeInMillis

Throws:

IllegalArgumentException

getRecentLikedPostsByUserAndDate

List<Post> getRecentLikedPostsByUserAndDate(String userid,
 long timeInMillis)
                                     throws IllegalArgumentException

Parameters:

userid - user identifier

timeInMillis - time in milliseconds from which you want to start retrieve the feeds

Returns:

the likes made to feeds in the range from: today to: timeInMillis

Throws:

IllegalArgumentException

getAllLikesByFeed

List<Like> getAllLikesByFeed(String postid)

Deprecated.

use getAllLikesByPost

Parameters:

postid - postid identifier return all the likes belonging to the postid

getAllLikesByPost

List<Like> getAllLikesByPost(String postid)

Parameters:

postid - postid identifier return all the likes belonging to the postid

saveHashTags

boolean saveHashTags(String postid,
 String vreid,
 List<String> hashtags)
              throws FeedIDNotFoundException

Parameters:

hashtags - the hashtag including the '#'

postid - the postid to which the hashtag is associated

vreid - VRE identifier

Returns:

true if success, false otherwise

Throws:

FeedIDNotFoundException

saveHashTagsComment

boolean saveHashTagsComment(String commentId,
 String vreid,
 List<String> hashtags)
                     throws CommentIDNotFoundException

Parameters:

hashtags - the hashtag including the '#'

commentId - the commentId to which the hashtag is associated

vreid - VRE identifier

Returns:

true if success, false otherwise

Throws:

CommentIDNotFoundException

deleteHashTags

boolean deleteHashTags(String postid,
 String vreid,
 List<String> hashtags)
                throws FeedIDNotFoundException

Parameters:

hashtags - the hashtag including the '#'

postid - the postid to which the hashtag is associated

vreid - VRE identifier

Returns:

true if success, false otherwise

Throws:

FeedIDNotFoundException

deleteHashTagsComment

boolean deleteHashTagsComment(String commentId,
 String vreid,
 List<String> hashtags)
                       throws CommentIDNotFoundException

Parameters:

hashtags - the hashtag including the '#'

commentId - the commentId to which the hashtag is associated

vreid - VRE identifier

Returns:

true if success, false otherwise

Throws:

CommentIDNotFoundException

getVREHashtagsWithOccurrence

Map<String,Integer> getVREHashtagsWithOccurrence(String vreid)

get a map of VRE hashtags where the key is the hashtag and the value is the occurrence of the hashtag in the VRE.

Parameters:

vreid - VRE identifier (scope).

Returns:

a Map of hashtags associated with their occurrence.

getVREHashtagsWithOccurrenceFilteredByTime

Map<String,Integer> getVREHashtagsWithOccurrenceFilteredByTime(String vreid,
 long timestamp)

get a map of VRE hashtags where the key is the hashtag and the value is the occurrence of the hashtag in the VRE.

Parameters:

vreid - VRE identifier (scope).

timestamp - Do not consider hashtags used before this timestamp.

Returns:

a Map of hashtags associated with their occurrence.

getVREFeedsByHashtag

List<Feed> getVREFeedsByHashtag(String vreid,
 String hashtag)
                         throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
FeedIDNotFoundException,
ColumnNameNotFoundException

Deprecated.

use getVREPostsByHashtag

Parameters:

vreid - VRE identifier

hashtag - the hashtag to look for including the '#', it is case sensitive

Returns:

all the feeds having the hashtag passed as parameter

Throws:

ColumnNameNotFoundException - .

FeedIDNotFoundException - .

FeedTypeNotFoundException - .

PrivacyLevelTypeNotFoundException

FeedIDNotFoundException - .

getVREPostsByHashtag

List<Post> getVREPostsByHashtag(String vreid,
 String hashtag)
                         throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
FeedIDNotFoundException,
ColumnNameNotFoundException

Returns all posts in a VRE that contain a specific hashtag.

Parameters:

vreid - The VRE identifier.

hashtag - The hashtag to search for (including the '#'). Case-sensitive.

Returns:

A List of posts containing the specified hashtag.

Throws:

PrivacyLevelTypeNotFoundException - If a privacy level is not recognized.

FeedTypeNotFoundException - If a feed type is not recognized.

FeedIDNotFoundException - If a feed ID is not found.

ColumnNameNotFoundException - If a column name is not found.

saveInvite

InviteOperationResult saveInvite(Invite invite)
                          throws jakarta.mail.internet.AddressException

Save the invite for a given email into a given vre

Parameters:

invite - the invite object instanc to save

Returns:

InviteOperationResult SUCCESS, FAILED or ALREADY_INVITED (if an invite is sent to en existing email in the same environment more than once)

Throws:

jakarta.mail.internet.AddressException

isExistingInvite

String isExistingInvite(String vreid,
 String email)

Parameters:

vreid - the environment where you want to check the invite

email - the email of the invite to check in the environmnet

Returns:

the InviteId if present, null otherwise

readInvite

Invite readInvite(String inviteid)
           throws InviteIDNotFoundException,
InviteStatusNotFoundException

read an invite from a given id

Throws:

InviteIDNotFoundException

InviteStatusNotFoundException

setInviteStatus

boolean setInviteStatus(String vreid,
 String email,
 InviteStatus status)
                 throws InviteIDNotFoundException,
InviteStatusNotFoundException

set the status of an invite, see InviteStatus

Throws:

InviteIDNotFoundException

InviteStatusNotFoundException

getInvitedEmailsByVRE

List<Invite> getInvitedEmailsByVRE(String vreid,
 InviteStatus... status)
                            throws InviteIDNotFoundException,
InviteStatusNotFoundException

Use to get the list of invites per VRE

Parameters:

vreid - the vre id

status - optional, if you want to restict on the status, e.g. all pending invites

Returns:

return the list of invites

Throws:

InviteIDNotFoundException

InviteStatusNotFoundException

getAttachmentsByFeedId

List<Attachment> getAttachmentsByFeedId(String feedId)
                                 throws FeedIDNotFoundException

Parameters:

feedId -

Returns:

the list of attachments of the feed feedId, starting from the second one (first attachment is included in Feed instance already)

Throws:

FeedIDNotFoundException

saveAttachmentEntry

boolean saveAttachmentEntry(String feedId,
 Attachment toSave)

save an attachment

getAllVREIds

List<String> getAllVREIds()

Retrieve all the ids of the vre

Returns:

the set of ids of the vre available or empty list in case of errors.

closeConnection

void closeConnection()

close the connection to the underlying database